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

Fix documentation that can seem empty #45

Open
ivanahuckova opened this issue Aug 19, 2024 · 0 comments
Open

Fix documentation that can seem empty #45

ivanahuckova opened this issue Aug 19, 2024 · 0 comments

Comments

@ivanahuckova
Copy link
Member

When visiting Yugabyte) it wasn’t apparent right away that there were docs sub-pages for config and querying. This made me think the docs were basically empty, especially since data source docs have existed on one long page in the past.
There are some other docs pages that have a short “overview” page and put details into sub-page. They use the {{< section >}} tag to display a “table of contents” for their sub-pages inline, so that users who land on the overview page know they should nav to sub-pages. We should implement that.

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

No branches or pull requests

1 participant