leanprover / leanprover/reference-manual

Document permalinks/xref system

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

Nobody has claimed this yet.

ASAP doc-request
Dominant language
Lean
Stars
129
Forks
67
Avg merge
1d 15h
Merged PRs (30d)
16

Description

What question should the reference manual answer?

How do I implement a Zulip linkifier to this document?

The answer should be included in the introduction. Probably it makes most sense to have a command in the Verso manual genre that includes some standard instructions for this, as many books will want it.

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 with the reference manual introduction and inspect how the Verso manual genre defines commands or standard instructions. Document how to implement a Zulip linkifier for this document, and consider whether the guidance belongs in a reusable genre command; done means the introduction answers the question clearly.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.