libp2p / libp2p/docs

Upgrade Doks to the PL docs-starter

Open
#248 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

area:general blocked P3 type:refactor
Dominant language
HTML
Stars
72
Forks
97
PR merge metrics
No merged PRs in 30d

Description

To do when docs-starter is in a stable state.

Done Criteria

Why Important

This marks the next step in the Doks migration. The docs starter package adds additional functionality to the Doks theme. One notable one is the reintroduction of tabs.

Notes

Created by @johnnymatthews who can act as the SME.

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

First confirm that the docs-starter package is in a stable state, then locate the current Doks theme configuration and compare it with the docs-starter package. Done means the configuration uses docs-starter and its added functionality, including tabs, is available; @johnnymatthews is listed as the subject-matter expert.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
documentation
Issue type
Feature
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.