-
-
Notifications
You must be signed in to change notification settings - Fork 5
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.
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
[2.x] Clean up the navigation documentation #1828
Merged
caendesilva
merged 66 commits into
unify-the-navigation-api
from
clean-up-the-navigation-documentation
Jul 12, 2024
Merged
[2.x] Clean up the navigation documentation #1828
caendesilva
merged 66 commits into
unify-the-navigation-api
from
clean-up-the-navigation-documentation
Jul 12, 2024
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
I think it's confusing to note these, it's best to document the canonical ones, but silently support alternates for fault tolerance and interoperability.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## unify-the-navigation-api #1828 +/- ##
============================================================
Coverage 100.00% 100.00%
Complexity 1855 1855
============================================================
Files 190 190
Lines 4909 4909
============================================================
Hits 4909 4909 ☔ View full report in Codecov by Sentry. |
4 tasks
Not sure how much value this offers
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.
Part of #1818 and goes over the entire navigation documentation to ensure it's consistent and concise, without losing information.
Additionally, it rethinks the document outline to account for many people not reading the document top to bottom, and instead only read sections at a time. As such, words that tie together sections have been removed, in order to make each section usable on its own.
It also updates headings to be more concise, instead of fluent English, to make the sections more skimmable.