virtualsquare / virtualsquare/vuos

Documentation system

Open
#17 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement help wanted
Dominant language
C
Stars
49
Forks
11
PR merge metrics
No merged PRs in 30d

Description

Add a documentation system and document the code with it. (please don't say Doxygen)

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 inspecting the repository to determine its current documentation structure and identify what “documentation system” is intended to cover. The issue names no files, tests, or preferred system, so clarify the system choice and scope before changing code. Done means the system is added and the code is documented consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
c
Domain
documentation, operating-systems
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.