Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature] Styleguidist overhaul #766

Merged
merged 2 commits into from
Sep 4, 2023

Conversation

riitasointi
Copy link
Collaborator

Description

PR includes a thorough overhaul to the Styleguidist component pages. Examples are improved throughout and links are provided at the top of the page to quickly navigate to different sections as well as the props list.

Motivation and Context

We want our documentation to be coherent and consistent, and provide good examples as well as accessibility information.

Release notes

General

  • Facelift Styleguidist component pages and code examples

src/core/Alert/Alert.md Outdated Show resolved Hide resolved
src/core/Block/Block.md Outdated Show resolved Hide resolved
Copy link
Contributor

@danielck danielck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Jolly good!

riitasointi and others added 2 commits August 30, 2023 13:20
WIP: Facelift Styleguidist component pages

improve WizardNavigation documentation page

improve VisuallyHidden documentation

improve tooltip documentation page

WIP: Facelift Styleguidist component pages

update ToggleInput and ToggleButton documentation

improve toast documentation page

improve TextInput documentation page

improve textarea documentation page

improve textinput example content

WIP: Facelift Styleguidist component pages

improve texarea examples

improve text and paragraph documentation pages

improve statustext documentation page

WIP: Facelift Styleguidist component pages
Styleguidist: Change links to markdown format

Adjust component docs

Adjust Expander docs

Adjust Breadcrumb docs

Co-authored-by: Daniel Koskinen <[email protected]>

Adjust Breadcrumb docs

Co-authored-by: Daniel Koskinen <[email protected]>

Adjust Expander docs

Co-authored-by: Daniel Koskinen <[email protected]>

Adjust Expander docs

Co-authored-by: Daniel Koskinen <[email protected]>

Adjust Expander docs

Adjust Checkbox docs

Co-authored-by: Daniel Koskinen <[email protected]>

Adjust Checkbox docs

Co-authored-by: Daniel Koskinen <[email protected]>

Adjust Checkbox docs

Co-authored-by: Daniel Koskinen <[email protected]>

Adjust Checkbox docs

Adjust Link docs

Adjust TextInput docs

Co-authored-by: Daniel Koskinen <[email protected]>

Adjust Toggle docs

Co-authored-by: Daniel Koskinen <[email protected]>

Adjust LanguageMenu docs

Co-authored-by: Daniel Koskinen <[email protected]>

Adjust Link docs

Co-authored-by: Daniel Koskinen <[email protected]>

Adjust Modal docs

Co-authored-by: Daniel Koskinen <[email protected]>

Adjust Modal docs

Co-authored-by: Daniel Koskinen <[email protected]>
@riitasointi riitasointi force-pushed the feature/documentation-improvements branch from 8b3c82d to 823f2e8 Compare August 30, 2023 10:21
@riitasointi riitasointi merged commit e40b188 into develop Sep 4, 2023
@riitasointi riitasointi deleted the feature/documentation-improvements branch September 4, 2023 11:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants