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.

Sign up for GitHub

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

Jump to bottom

Adding instructions for adding sub-pages to packages documentation. #43750

Merged
merged 2 commits into from
Sep 1, 2022
Merged

Adding instructions for adding sub-pages to packages documentation. #43750

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e835a13
Adding instructions for adding sub-pages to packages documentation.
ryanwelcher Aug 31, 2022
367c3c2
Fix typo.
ryanwelcher Aug 31, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Fix typo.
  • Loading branch information
@ryanwelcher
ryanwelcher committed Aug 31, 2022
commit 367c3c2ef8797c473c1c0d4143f098697eea6702
2 changes: 1 addition & 1 deletion docs/contributors/documentation/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ If you forget to run, `npm run docs:build` your PR will fail the static analysis

### Documenting Packages

Package documentation is generated automatically but the documentation tool by pulling the contents of the README.md file located in the root of the package. Sometimes however, it is preferable to split the contents of the README out into smaller, easier to read portions.
Package documentation is generated automatically by the documentation tool by pulling the contents of the README.md file located in the root of the package. Sometimes however, it is preferable to split the contents of the README out into smaller, easier to read portions.

This can be accomplished by creating a `docs` directory in the package and adding `toc.json` file that contains references other markdown files also contained in the `docs` directory. The `toc.json` file should contain an array of pages to be added as sub-pages of the main README file. The formatting follows the [`manifest.json`](https://github.com/WordPress/gutenberg/blob/HEAD/docs/manifest.json) file that is generated automatically.

Expand Down