MambaCodes / MambaCodes/wstack-docs

Refactoring required in `Introduction`

Open
#5 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
TypeScript
Stars
0
Forks
3
PR merge metrics
No merged PRs in 30d

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 wstack repo); 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 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

  • Technical review completed
  • Implementation details updated
  • Verify code samples match current codebase
  • Add links to relevant backend docs

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the Introduction content in docs/ and review its existing introduction, #-ai-usage-restriction, and #-api-calls sections. Compare the API material with the wstack repository and verify that proposed links and code samples match the current backend. Done means the introduction is concise, linked sections exist, AI guidance is updated, and the Hono-based API documentation is accurate.

Written by the indexing model from the issue text.

Assessment

Tech stack
nextjs
Domain
api, backend, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.