Add an integrated documentation website

Open
#2 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
typescript

Research direction

Start by reviewing the repository structure and the existing TypeScript package workflow to determine where an integrated documentation site could fit. Define the deployment approach, Markdown and code-snippet support, extension model, and landing-page scope before implementation; done means forks can deploy and customize the documentation site for their packages.

Written by the indexing model from the issue text.

Description

A documentation website baked into the stack so forks can:

  • Deploy it for free
  • Document the open-source package
  • Have a way to support md and code snippets so they can showcase examples
  • Allow easy extension
  • Add cool landing page?
Dominant language
TypeScript
Stars
121
Forks
11
PR merge metrics
No merged PRs in 30d

Getting set up

  • No Dockerfile or Docker Compose file
  • Has a pull request template
  • No contributing guide

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.

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.