FIRST-Tech-Challenge / FIRST-Tech-Challenge/ftcdocs

Determine appropriate use of usage.rst

Open
#21 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Nix
Stars
23
Forks
57
Avg merge
1d 20h
Merged PRs (30d)
15

Description

Determine the appropriate use of usage.rst. If the file is to be used by those who are contributing, should this file be a .rst file along with the rest of the docs? If this is merely for developers, does it make more sense to move it to the root of the file structure and change to markdown to be more GitHub-viewing-friendly?

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reading usage.rst and the repository's Sphinx documentation structure. Determine whether the file serves contributors or developers, then establish whether it belongs with the .rst docs or at the repository root as Markdown; done means its audience, location, and format have been decided.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Documentation
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.