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.

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

Conversation

caendesilva
Copy link
Member

@caendesilva caendesilva commented Jul 11, 2024

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.

Copy link

codecov bot commented Jul 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (3f92d37) to head (b47bae0).

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.
📢 Have feedback on the report? Share it here.

@caendesilva caendesilva mentioned this pull request Jul 11, 2024
4 tasks
@caendesilva caendesilva marked this pull request as ready for review July 12, 2024 08:17
@caendesilva caendesilva merged commit c363a81 into unify-the-navigation-api Jul 12, 2024
8 checks passed
@caendesilva caendesilva deleted the clean-up-the-navigation-documentation branch July 12, 2024 08:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant