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.

Sign up for GitHub

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

Jump to bottom

Add docs using Starlight #7

Open
BryceRussell opened this issue May 11, 2024 · 0 comments
Open

Add docs using Starlight #7

BryceRussell opened this issue May 11, 2024 · 0 comments
Labels
good first issue Good for newcomers help wanted Extra attention is needed

Comments

@BryceRussell
Copy link
Owner

BryceRussell commented May 11, 2024 •
edited
Loading

The project needs better docs, we can use Starlight to create a documentation website

  1. Create a Starlight project at the root of the repo inside /docs
  2. Transfer markdown from the wiki into the src/content/docs folder
  3. Configure Starlight (sidebar, title, description, home page, etc)
  4. Move /images folder into docs at src/assets
@BryceRussell BryceRussell added help wanted Extra attention is needed good first issue Good for newcomers labels May 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@BryceRussell