Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

[Feature Request]: Docusaurus integration #720

Closed
geromegrignon opened this issue Sep 7, 2021 · 1 comment
Closed

[Feature Request]: Docusaurus integration #720

geromegrignon opened this issue Sep 7, 2021 · 1 comment
Assignees

Comments

@geromegrignon
Copy link
Contributor

Relevant Scope

Other: describe below

Description

### Current status

The content of each markdown file is quite long.
Each file is full of links, making it difficult to navigate through the specs.
With the V2, specs will be longer to align with modern standards

Describe the solution you'd like

I'm considering adding Docusaurus to this repository and hosting it with Github Pages.

Benefits:
- a better user experience
- a versioning solution which help the transition to the V2


Here are the Docusaurus docs showcasing the solution: https://docusaurus.io/docs

Describe alternatives you've considered

At this point, Docusaurus is an arbitrary choice as it's one of the few solutions I'm aware of. I'm open to related alternatives.
@geromegrignon
Copy link
Contributor Author

The documentation is now live on GitHub Pages: https://gothinkster.github.io/realworld/
I moved the existing documentation, additional tasks will be required to improve it.

I updated the description of the repository :
image

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant