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

[Documentation] Add docusaurus documentation #42

Open
5 tasks
Olshansk opened this issue Oct 10, 2024 · 0 comments
Open
5 tasks

[Documentation] Add docusaurus documentation #42

Olshansk opened this issue Oct 10, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@Olshansk
Copy link
Contributor

Olshansk commented Oct 10, 2024

Objective

Add modern-looking docs to the path repo

Origin Document

docusaurus.io was used in the poktroll repo here to deploy the documentation at dev.poktroll.com.

Screenshot 2024-10-10 at 11 23 30 AM

Goals

  • Make PATH onboarding simple, easy & attractive w/ good, easy-to-navigate and visually asthetic documentation

Deliverables

  • [@Olshansk] Add docusarusus to the docs in the same way it's implemented in poktroll
  • [@Olshansk] Link to 👇 in the README
  • [@Olshansk] Add Makefile helpers (see image above) in the Makefile of this repo for development purposes
  • [@okdas] Deploy the docs to docs.grove.city similar to dev.poktroll.com
  • [@fredteumer] Link to ☝️ somewhere on grove.city

Non-goals / Non-deliverables

  • Updating the existing documentation
  • Adding new documentation

Creator: @Olshansk
Co-Owners: @fredteumer

@Olshansk Olshansk added the documentation Improvements or additions to documentation label Oct 10, 2024
@Olshansk Olshansk added this to the Path MVP milestone Oct 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: 🔖 Ready
Development

No branches or pull requests

2 participants