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

docs: reorganize api docs #1445

Merged
merged 12 commits into from
Feb 12, 2025
Merged

docs: reorganize api docs #1445

merged 12 commits into from
Feb 12, 2025

Conversation

TC-MO
Copy link
Contributor

@TC-MO TC-MO commented Feb 6, 2025

No description provided.

@github-actions github-actions bot added the t-docs Issues owned by technical writing team. label Feb 6, 2025
@TC-MO TC-MO added the documentation Improvements or additions to documentation. label Feb 6, 2025
TC-MO added 6 commits February 6, 2025 16:14
remove HTMl from section descriptions
change order of operations so deprecated endpoints are always last
add redirects to group sections in nginx.conf
streamline descriptions by moving shared parts to grouping introductions
fix formatting
remove HTML when possible
split request queues into 3 sub-categories
change descriptions for introductory pages to reflect new division
reorganize sidebar further
add missin request queues redirects to ngninx.conf
@TC-MO TC-MO marked this pull request as ready for review February 6, 2025 21:17
@TC-MO TC-MO requested review from B4nan and netmilk February 6, 2025 21:17
@TC-MO
Copy link
Contributor Author

TC-MO commented Feb 6, 2025

@netmilk from my lcoal testing, it seems that endpoints themselves did not change URLs whatsoever with those changes, just the subgroups did and for that I've used nginx to redirect to the new groupings.

@TC-MO TC-MO merged commit d676859 into master Feb 12, 2025
7 checks passed
@TC-MO TC-MO deleted the reorganize-api-docs branch February 12, 2025 11:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation. t-docs Issues owned by technical writing team.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants