libp2p / libp2p/js-libp2p

docs: Integrated a docs web page generator for js-libp2p specifically

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

Nobody has claimed this yet.

kind/discussion need/analysis need/triage topic/docs
Dominant language
TypeScript
Stars
2.6k
Forks
546
Avg merge
8h 18m
Merged PRs (30d)
16

Description

Using a tool like https://docusaurus.io/ so that we can host the docs folder and generated docs.

Contributor guide

Open the 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.

Research direction

Review the repository's docs folder and the proposed Docusaurus integration. Determine the required hosting and generated-docs behavior, then define completion as the docs being generated and hosted through the integrated documentation site.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.