Skip to content

Docs reorganization #49

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

Merged
merged 6 commits into from
Jun 26, 2025
Merged

Docs reorganization #49

merged 6 commits into from
Jun 26, 2025

Conversation

Valian
Copy link
Owner

@Valian Valian commented Dec 12, 2024

Done mostly by Cursor, based on README content.

TODO:

  • check if everything needed is in Installation.md
  • trim README, include links to docs
  • reconsider top - level documentation sections
    • are they clear, matching what people are looking for?
image image

@coveralls
Copy link

Pull Request Test Coverage Report for Build 6fd0b58fe842605aaa27f43d18f3b3e58114624d-PR-49

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 46.939%

Totals Coverage Status
Change from base Build 9d953ebc5953f4f70c84a850c4ebe14f8cf0ceda: 0.0%
Covered Lines: 69
Relevant Lines: 147

💛 - Coveralls

@Valian Valian changed the title WIP: Docs rewrite Docs rewrite Jun 26, 2025
@Valian Valian changed the title Docs rewrite Docs reorganization Jun 26, 2025
@Valian
Copy link
Owner Author

Valian commented Jun 26, 2025

Ok after working on this on and off I think we're in a much better place. Don't look at commits though, they'll be all squashed anyway 😂

Let's merge and onward towards 0.6.0!

@Valian Valian merged commit f08ee24 into main Jun 26, 2025
0 of 3 checks passed
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