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

Beginning section for data-driven API section in the docs. #1300

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

allenheltondev
Copy link
Collaborator

Built an example and a builder for docs from a json schema
The API section is intended to incorporate API definitions across all products, similar to how Stripe approaches the API reference. We will still have product focused sections in the docs, but that's more driven toward use cases, workflows, and quick starts (all future)
I also have in there an example of how to link to sections inside of a page from the navbar 🔥

NOTE: This is not completely done, but I'm moving off of this for now. The new content is not linked from the primary docs definition, so it's undiscoverable by obscurity

If you want to pull it down and look, you can go to http://localhost:3000/api

…xample and a builder for docs from a json schema
Copy link
Contributor

@cprice404 cprice404 left a comment

Choose a reason for hiding this comment

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

i will pull this down and play with it sometime soonish when time permits, sounds cool!

the build is failing, haven't looked into why yet. once that is resolved i have no problem with shipping this dark.

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.

2 participants