Skip to content

Conversation

@emmadesilva
Copy link
Member

@emmadesilva emmadesilva 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.

@codecov
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.

@emmadesilva emmadesilva mentioned this pull request Jul 11, 2024
4 tasks
@emmadesilva emmadesilva marked this pull request as ready for review July 12, 2024 08:17
@emmadesilva emmadesilva merged commit c363a81 into unify-the-navigation-api Jul 12, 2024
@emmadesilva emmadesilva 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.

2 participants