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.

Sign up for GitHub

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

Jump to bottom

API Docs Guides root page is empty #693

Closed
1 task
sarayourfriend opened this issue Jun 17, 2022 · 1 comment
Closed
1 task

API Docs Guides root page is empty #693

sarayourfriend opened this issue Jun 17, 2022 · 1 comment
Assignees
@dhruvkb
Labels
📄 aspect: text Concerns the textual material in the repository 🧰 goal: internal improvement Improvement that benefits maintainers, not users 🟩 priority: low Low priority and doesn't need to be rushed 🧱 stack: api Related to the Django API

Comments

@sarayourfriend
Copy link
Collaborator

Description

https://wordpress.github.io/openverse-api/guides/index.html

Reported by @krysal

We should at least write what the user can expect in the guides.

One quick solution would be to remove the :hidden: directive in the toctree in guides/index.md, so that at least the TOC for the guides shows.

Resolution

  • 🙋 I would be interested in resolving this bug.
@sarayourfriend sarayourfriend added 🟩 priority: low Low priority and doesn't need to be rushed 📄 aspect: text Concerns the textual material in the repository 🧰 goal: internal improvement Improvement that benefits maintainers, not users labels Jun 17, 2022
@obulat obulat transferred this issue from WordPress/openverse-api Feb 22, 2023
@zackkrida zackkrida mentioned this issue Feb 22, 2023
Closed
7 tasks
@github-project-automation github-project-automation bot moved this to 📋 Backlog in Openverse Backlog Feb 23, 2023
@dhruvkb dhruvkb self-assigned this Feb 25, 2023
@dhruvkb
Copy link
Member

dhruvkb commented Feb 25, 2023 •
edited
Loading

The monorepo docs at https://wordpress.github.io/openverse/guides/index.html, updated in #443, have a populated guides page.

@dhruvkb dhruvkb closed this as completed Feb 25, 2023
@github-project-automation github-project-automation bot moved this from 📋 Backlog to ✅ Done in Openverse Backlog Feb 25, 2023
@AetherUnbound AetherUnbound added 🧱 stack: api Related to the Django API and removed 🧱 stack: backend labels May 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dhruvkb dhruvkb

Labels
📄 aspect: text Concerns the textual material in the repository 🧰 goal: internal improvement Improvement that benefits maintainers, not users 🟩 priority: low Low priority and doesn't need to be rushed 🧱 stack: api Related to the Django API
Projects
Openverse Backlog
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add table of contents to "guides" docs page WordPress/openverse
4 participants
@AetherUnbound @obulat @dhruvkb @sarayourfriend