rocq-prover / rocq-prover/platform-docs

Improve Welcoming page (set up Sphinx ?)

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

Nobody has claimed this yet.

Web Interface
Dominant language
Rocq Prover
Stars
26
Forks
25
Avg merge
2d 22h
Merged PRs (30d)
1

Description

Improve the welcoming page. https://coq.inria.fr/platform-docs/
Potentially use sphinx or sth similar to organize the tutorials ?

Contributor guide

Open the contributing guide

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 welcoming page at https://coq.inria.fr/platform-docs/ and the repository’s existing short tutorials and how-to guides. Investigate whether Sphinx or a similar tool fits the documentation structure. Done means the welcoming page is improved and the tutorials are organized through an agreed documentation approach.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
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.