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

Make API Docs out of Redocusaurus #5

Merged
merged 6 commits into from
Aug 11, 2021
Merged

Conversation

Zhao-Andy
Copy link
Contributor

@Zhao-Andy Zhao-Andy commented Aug 11, 2021

This adds the API docs based on our previous api_v0.yml file according to how Redoc would. This is generated through the Redocusaurus plugin: https://github.com/rohit-gohri/redocusaurus

Also adds some minor niceties like ignoring .env file, allowing development to run without ENV variables, and updating the URL.

@Zhao-Andy Zhao-Andy merged commit 4f8ff8e into main Aug 11, 2021
@rhymes
Copy link
Contributor

rhymes commented Aug 12, 2021

@Zhao-Andy does this mean that we'll have to copy over to this repository the api spec file everytime is changed or that we'll remove it from the main repo?

@rhymes rhymes deleted the try-redocusaurus-api-docs branch August 12, 2021 12:29
@Zhao-Andy
Copy link
Contributor Author

@rhymes I think we can remove the entire docs/ folder from the forem/forem repo, including the api spec file!

I was in the middle of copying over the last few commits in the docs/ directory, and should have everything ported today. Will let the rest of the team know too.

@rhymes
Copy link
Contributor

rhymes commented Aug 12, 2021

Thank you!

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