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

WIP: Introduce multi-instance docs with docs and guides nav sections #1407

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

derektolliver
Copy link
Contributor

@derektolliver derektolliver commented Jan 23, 2024

Introduce multi-instance docs with docs and guides sections in the top nav.

@psikoi Want your feedback on this current instance of the docs when you get the chance. I think there are still some open questions:

  1. What paths do we want the pages to follow? Currently introduction is at the base slug and the apis are all within a category which affects their path.
  2. Do we already have content to fill out a few pages of the guides section? It might be nice to have some base ones to start with instead of leaving them with placeholders/under construction, but totally up to you.

Let me know if you have any feedback on this current implementation you'd like me to change.

Including some simple screenshots for quick reference:

image image

Both of the guides pages are currently just placeholders.

Copy link

vercel bot commented Jan 23, 2024

@derektolliver is attempting to deploy a commit to the wiseoldman Team on Vercel.

A member of the Team first needs to authorize it.

@psikoi
Copy link
Member

psikoi commented Jan 23, 2024

Ideally the structure of the URLS would be:

/ <- a landing page, just somewhere users can choose where they want to navigate to
- I'll design this later, dw about the contents, could be just an empty page for this PR

/api/ <-- api intro
/api/players/* <-- players endpoints and entities
/api/groups/* <-- groups endpoints and entities
...etc

/guides <-- guides intro
/guides/how-to-setup-something <-- guide

/faq <--- a page where we can (later) add a bunch of FAQs

@psikoi
Copy link
Member

psikoi commented Jan 23, 2024

Reference for the type of layout I was thinking for the docs landing page btw: https://developer.redis.com/

Very simple, short summary at the top, big clickable cards underneath (that navigate to each of the areas)

@psikoi
Copy link
Member

psikoi commented Feb 19, 2024

@derektolliver What's the status on this? 🤔

@MikaelSvanasbakken
Copy link
Contributor

Looks like a neat thing to have @derektolliver are you able to finish this?

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

Successfully merging this pull request may close these issues.

None yet

3 participants