Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Refactoring required in `Introduction`

オープン
  • 何か問題がありますか？
#5 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
35/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
nextjs
領域
api, backend, documentation

調査の方向性

まず docs/ 内の Introduction の内容を見つけ、既存の Introduction、#-ai-usage-restriction、#-api-calls セクションを確認します。API の内容を wstack リポジトリと比較し、提案されているリンクとコードサンプルが現在のバックエンドと一致することを検証します。Introduction が簡潔で、リンクされたセクションが存在し、AI に関するガイダンスが更新され、Hono ベースの API ドキュメントが正確であれば完了です。

索引モデルが issue の本文から書いたものです。

説明

enhancement

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
主要言語
TypeScript
スター
0
フォーク
3
30日以内にマージされた PR はありません

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

MambaCodes/wstack-docs のほかの issue

MambaCodes/wstack-docs の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。