rocq-prover / rocq-prover/platform-docs

The table of content should be an output, not an input

Open
#10 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

We should only give (unnumbered) titles, subtitles, etc and, if need be, the numbering and the table of content should be automatically written by some tool.

I can write some crude sh/awk/sed helpers, but maybe the format should stabilize before.

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

No file, test, or entry point is identified. Review the current tutorial and document format, then read the issue discussion to determine whether the format has stabilized; done means the agreed format and any corresponding helper-tool scope are documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
awk, shell
Domain
documentation, tooling
Issue type
Feature
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.