Skip to content
This repository has been archived by the owner on Dec 27, 2022. It is now read-only.

docs: improve documentation DX #472

Merged
merged 2 commits into from
Sep 12, 2022
Merged

docs: improve documentation DX #472

merged 2 commits into from
Sep 12, 2022

Conversation

baptisteArno
Copy link
Contributor

Type

  • Documentation

Description

This is my attempt on improving documentation DX. Here is what changed:

  • Stories sorting: it's now sorted by export as intended (Storybook packages update)
  • Folders are sorted in logical order: Form, Fields, SubmitErrorAlert, Submit (instead of alphabetical)
  • Show doc snippets don't show the Form decorator anymore
  • Form story shows a fully-fledge form instead of "I'm inside a Form"

Relevant logs and/or screenshots

Before After
CleanShot 2022-09-05 at 15 17 05@2x CleanShot 2022-09-05 at 15 17 15@2x
CleanShot 2022-09-05 at 15 36 45@2x CleanShot 2022-09-05 at 15 36 58@2x
CleanShot 2022-09-05 at 15 18 22@2x CleanShot 2022-09-05 at 15 18 38@2x
CleanShot 2022-09-05 at 15 18 06@2x CleanShot 2022-09-05 at 15 17 55@2x

@baptisteArno baptisteArno self-assigned this Sep 5, 2022
@baptisteArno baptisteArno added the documentation Improvements or additions to documentation label Sep 5, 2022
@codecov-commenter
Copy link

codecov-commenter commented Sep 5, 2022

Codecov Report

Merging #472 (a069d42) into main (e066780) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #472   +/-   ##
=======================================
  Coverage   91.78%   91.78%           
=======================================
  Files          25       25           
  Lines         280      280           
  Branches       35       35           
=======================================
  Hits          257      257           
  Misses         14       14           
  Partials        9        9           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ec7b808...a069d42. Read the comment docs.

@QuiiBz
Copy link
Contributor

QuiiBz commented Sep 9, 2022

By default we get this blank page, is it possible to select Introduction by default?

image

@baptisteArno
Copy link
Contributor Author

Couldn't solve initial page load, issue is tracked here: #483

scaleway-bot pushed a commit that referenced this pull request Sep 14, 2022
## [1.29.2](v1.29.1...v1.29.2) (2022-09-14)

### 📝 Documentation

* improve documentation DX ([#472](#472)) ([e1a4c20](e1a4c20))

### 📦 Chore

* **deps:** add require-from-string ([#496](#496)) ([95af3e5](95af3e5))
* **devdeps:** update dependency rollup-plugin-visualizer to v5.8.1 ([#492](#492)) ([4519c49](4519c49))
* **devdeps:** update dependency typescript to v4.8.3 ([#493](#493)) ([a733466](a733466))
* **pnpm:** update version ([#489](#489)) ([48bcf07](48bcf07))
@scaleway-bot
Copy link
Collaborator

🎉 This PR is included in version 1.29.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants