getodk / getodk/docs

Re-format CLI instructions to use sphinx-tabs for three different OSes

Open
#485 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
58
Forks
160
Avg merge
5d 11h
Merged PRs (30d)
12

Description

https://github.com/djungelorm/sphinx-tabs

This same approach can be used other places where we have diverging instructions based on platform, but doing it with CLI commands throughout the contributor technical guide would be the best first place.

Contributor guide

Open the contributing guide

Research direction

Start with the contributor technical guide and locate its CLI command instructions. Review the linked sphinx-tabs approach, then reformat the guide's platform-divergent instructions for the three operating systems; done means the guide presents those commands in tabs and remains clear to contributors.

Written by the indexing model from the issue text.

Assessment

Domain
cli, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 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.