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

Add API links to all docs pages #1661

Merged
merged 5 commits into from
Jul 6, 2023
Merged

Add API links to all docs pages #1661

merged 5 commits into from
Jul 6, 2023

Conversation

TodePond
Copy link
Collaborator

This PR adds links to the API reference from within the docs pages.
I think we should continue with this as we move forwards with more content.

We could tweak the threshold of what we link or don't link. I tried to strike a good balance (maybe linked too much though). We'd want lots of stuff to be clickable, so that users can dive into the API. But we don't want the screen to be a splattering of blue, distracting away from more important stuff.

Change Type

  • documentation — Changes to the documentation only1

Test Plan

  1. Try out some of the newly added links on the docs site.
  • Unit Tests
  • End to end tests

Release Notes

  • Documentation: Added links to API reference in guides.

Footnotes

  1. will not publish a new version

@vercel
Copy link

vercel bot commented Jun 27, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
examples ✅ Ready (Inspect) Visit Preview Jul 6, 2023 11:04am

@TodePond TodePond marked this pull request as ready for review June 27, 2023 16:40
@huppy-bot huppy-bot bot added the docs Changes only affect the documentation label Jun 27, 2023
@TodePond TodePond requested a review from steveruizok July 4, 2023 14:18
@TodePond TodePond added this pull request to the merge queue Jul 6, 2023
Merged via the queue into main with commit a316fd2 Jul 6, 2023
2 checks passed
@TodePond TodePond deleted the lu/docs-api-links branch July 6, 2023 14:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Changes only affect the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants