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

chore: reorganize API documentation #3668

Merged
merged 4 commits into from
Jul 15, 2024
Merged

Conversation

trujillo-adam
Copy link
Contributor

This PR contains changes from the last successful commit in PR 3659. The changes present separate pages for the resources in each language in the API reference. This is a temporary fix for the documentation until @DanielMSchmidt finishes updating the API reference documentation generator.

@trujillo-adam trujillo-adam added the documentation Improvements or additions to documentation label Jul 10, 2024
@trujillo-adam trujillo-adam requested review from a team as code owners July 10, 2024 15:58
@trujillo-adam trujillo-adam requested review from mutahhir and DanielMSchmidt and removed request for a team July 10, 2024 15:58
@DanielMSchmidt DanielMSchmidt changed the title Docs/atrujillo/api docs reorg chore: reorganize API documentation Jul 15, 2024
Copy link
Member

@ansgarm ansgarm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Nice work 👍
Only a small question about the new dependencies and one about the now 404-ing paths

@@ -173,27 +173,132 @@
"routes": [
{
"title": "Overview",
"path": "api-reference/overview"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can / Should we redirect this to just api-reference for old links to still work?

},
{
"title": "Typescript",
"path": "api-reference/typescript"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as for the overview page – can / should we add redirects to just api-reference?

@DanielMSchmidt
Copy link
Contributor

Merging this, @trujillo-adam could you do a quick follow up with the redirects @ansgarm mentioned (we have no idea how those work and figured maybe you do 🙈 )

@DanielMSchmidt DanielMSchmidt merged commit 710d4f8 into main Jul 15, 2024
433 checks passed
@DanielMSchmidt DanielMSchmidt deleted the docs/atrujillo/api-docs-reorg branch July 15, 2024 12:21
Copy link
Contributor

I'm going to lock this pull request because it has been closed for 30 days. This helps our maintainers find and focus on the active issues. If you've found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 15, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants