Skip to content

chore: restructure documentation with docs/ folder and OS-specific gu…#65

Merged
brainless merged 2 commits into
mainfrom
chore/update-readme-docs
Jul 9, 2025
Merged

chore: restructure documentation with docs/ folder and OS-specific gu…#65
brainless merged 2 commits into
mainfrom
chore/update-readme-docs

Conversation

@brainless
Copy link
Copy Markdown
Member

…ides

  • Create docs/ folder with structured documentation
  • Add OS-specific getting started guides:
    • Windows installation and setup guide
    • macOS installation and setup guide
    • Linux installation for various distributions
  • Create comprehensive CLI options documentation
  • Update README.md to be minimal with links to detailed docs
  • Improve documentation organization for better user experience

Addresses issue #64

🤖 Generated with Claude Code

brainless and others added 2 commits July 9, 2025 08:43
…ides

- Create docs/ folder with structured documentation
- Add OS-specific getting started guides:
  - Windows installation and setup guide
  - macOS installation and setup guide
  - Linux installation for various distributions
- Create comprehensive CLI options documentation
- Update README.md to be minimal with links to detailed docs
- Improve documentation organization for better user experience

Addresses issue #64

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
- Create comprehensive development.md with setup, building, testing, and contributing instructions
- Remove development sections from README to keep it minimal
- Add link to development guide in README documentation section
- Include architecture overview, debugging tips, and performance guidance
- Cover security considerations and future improvement areas

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@brainless brainless merged commit 8630a72 into main Jul 9, 2025
1 check passed
@brainless brainless deleted the chore/update-readme-docs branch July 9, 2025 03:25
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.

1 participant