This issue outlines necessary improvements to the repository's documentation structure and content to enhance clarity and maintain consistency with project standards in docs/ a.k.a Introduction
Proposed Changes
1. Streamline Introduction Section
Current State
Introduction is overly verbose and reads like a blog post rather than project documentation.
Requested Change
- Trim introductory content to be more concise
- use more images/banners than text
- Maintain only essential headings with brief descriptions
- Add direct links to detailed documentation pages
- Follow the pattern:
Example Structure
## API Usage
[Brief 2-3 sentence description]
For full documentation: [API Overview](/docs/API/Overview)
Acceptance Criteria
2. Revise AI Usage Guidance
Current State
#-ai-usage-restriction section sends conflicting messages about AI tool usage.
Requested Change
- Remove restrictive language about AI usage
- Add helpful system prompt for AI-assisted development:
## AI Assistance Guidance
For optimal results with AI tools (Cursor, VS Code Copilot, etc.), use this prompt:
"When working with [Project Name], follow these patterns: [list key patterns]"
- Include examples of AI-friendly configuration
Acceptance Criteria
3. Update API Documentation
Current State
#-api-calls section contains Next.js implementation details. But we're using HONO.dev
Requested Change
- Conduct technical review of API documentation in contrast with the
wstack repo
- Update content to reflect current backend implementation
- Add direct link to backend documentation:
See backend implementation: [API Services](/docs/API/Services)
Acceptance Criteria
This issue outlines necessary improvements to the repository's documentation structure and content to enhance clarity and maintain consistency with project standards in
docs/a.k.aIntroductionProposed Changes
1. Streamline Introduction Section
Current State
Introduction is overly verbose and reads like a blog post rather than project documentation.
Requested Change
Example Structure
Acceptance Criteria
2. Revise AI Usage Guidance
Current State
#-ai-usage-restrictionsection sends conflicting messages about AI tool usage.Requested Change
Acceptance Criteria
introductionwstackrepo); so please open new issues.3. Update API Documentation
Current State
#-api-callssection contains Next.js implementation details. But we're usingHONO.devRequested Change
wstackrepoSee backend implementation: [API Services](/docs/API/Services)Acceptance Criteria