Unverified Commit 0a0c8e02 authored by Alpha's avatar Alpha Committed by GitHub

Enhanced grammar. (#42148)

closes  https://github.com/vercel/next.js/issues/42147

This PR enhances the grammar in adding-documentation README.
parent 9bf811ee
# Updating Documentation Paths # Updating Documentation Paths
Our documentation currently leverages a [manifest file](/docs/manifest.json) which is how documentation entries are checked. Our documentation currently leverages a [manifest file](/docs/manifest.json), which is how documentation entries are checked.
When adding a new entry under an existing category you only need to add an entry with `{title: '', path: '/docs/path/to/file.md'}`. The "title" is what is shown on the sidebar. When adding a new entry under an existing category you only need to add an entry with `{title: '', path: '/docs/path/to/file.md'}`. The "title" is what is shown on the sidebar.
When moving the location/url of an entry the "title" field can be removed from the existing entry and the ".md" extension removed from the "path", then a "redirect" field with the shape of `{permanent: true/false, destination: '/some-url'}` can be added. A new entry should be added with the "title" and "path" fields if the document was renamed within the [`docs` folder](/docs) that points to the new location in the folder e.g. `/docs/some-url.md` When moving the location/url of an entry, the "title" field can be removed from the existing entry and the ".md" extension removed from the "path", then a "redirect" field with the shape of `{permanent: true/false, destination: '/some-url'}` can be added. A new entry should be added with the "title" and "path" fields if the document is renamed within the [`docs` folder](/docs) that points to the new location in the folder, e.g. `/docs/some-url.md`
Example of moving documentation file: Example of moving documentation file:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment