chore(docs): add all Markdown files to docs app #1436
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 5b67a3a. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this branch ✅ Successfully ran 4 targetsSent with 💌 from NxCloud. |
3 tasks
… the docs project
LayZeeDK
reviewed
Oct 15, 2022
There was a problem hiding this comment.
@ChristopherPHolder
Please review my changes:
- Move and include remaining
libs/**/docs/Readme.mdfiles - Correct Markdown outlines for proper tables of contents
- Correct image embed URLs
- Use Sentence case for titles and headings
- Simplify navigation structure and configuration
- Order State navigation
- Update ESLint plugin's
docsUrlfunction - Configure API reference slugs
LayZeeDK
approved these changes
Oct 15, 2022
There was a problem hiding this comment.
@LayZeeDK All changes have been reviewed, I left a couple of questions.
Should consider unifying the approach we use to link internal MD files?
Examples of different linking styles in the repo:
apps/docs/docs/state/concepts-and-best-practices/concepts-and-best-practices.mdx
Show resolved
Hide resolved
564c4d5 to
5b67a3a
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
CONTRIBUTING.mdand packageREADME.mdsCloses #1430.