yt-project / yt-project/libyt

Consider using `Shibuya` theme in sphinx

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

Nobody has claimed this yet.

doc new feature
Dominant language
C++
Stars
23
Forks
7
PR merge metrics
No merged PRs in 30d

Description

Shibuya supports more markups like (ex: keyboards, menus, etc), structures the layout more clearer, and it has a navbar.

Content
  • API
  • Contributor guide: good first issue, integration template etc.
  • Simulations
  • Tutorial (how to?) / Blog

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 reviewing the linked Shibuya theme and the project's Sphinx documentation setup. Assess the API, contributor guide, simulations, and tutorial/blog areas listed in the issue; done means the theme direction and scope for these documentation sections are decided.

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
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.