-
Notifications
You must be signed in to change notification settings - Fork 3
Open
Labels
enhancementNew feature or requestNew feature or request
Description
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
- Introduction trimmed and also is having more banners.
- All major sections contain documentation links
- Verify all linked doc pages exist
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
- Remove existing restriction section from
introduction - Add new AI guidance section
- Verify prompt examples work with common AI tools
- *Make and Add new system prompt for the project. (will require changes here as well as in the
wstackrepo); so please open new issues.
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
wstackrepo - Update content to reflect current backend implementation
- Add direct link to backend documentation:
See backend implementation: [API Services](/docs/API/Services)
Acceptance Criteria
- Technical review completed
- Implementation details updated
- Verify code samples match current codebase
- Add links to relevant backend docs
Metadata
Metadata
Assignees
Labels
enhancementNew feature or requestNew feature or request