Docs: Move Steps Shorthands to a separate page to fix Steps TOC #1265
Conversation
This file contains 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
adamziel
added
[Type] Bug
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.
What is this PR doing?
Moves the Steps Shorthands documentation, merged in #1261, to a separate page.
What problem is it solving?
@ironnysh noted that merging the PR messed up the table of contents on the steps page:
That specific ToC is generated using a custom React component that doesn't seems to handle merging new entries with any pre-existing structure. We could fix it, but since we might soon move to a Playground-based documentation workflow, investing time in Docusaurus setup doesn't make much sense. I went for the easy way out and moved the information to a new page.
Testing Instructions
Run
nx dev docs-sitelocally and confirm the toc on the Steps page is in tact.