nervosnetwork / nervosnetwork/rfcs
Use inline LaTeX to replace images and code tags in RFCs
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 271
- Forks
- 158
- PR merge metrics
- No merged PRs in 30d
Description
RFCs like https://github.com/nervosnetwork/rfcs/blob/master/rfcs/0020-ckb-consensus-protocol/0020-ckb-consensus-protocol.md uses a lot of formulas. Since GitHub has shipped the feature to render inline LaTeX, it's time to replace the images for better reading experience.
RFC like https://github.com/nervosnetwork/rfcs/blob/master/rfcs/0023-dao-deposit-withdraw/0023-dao-deposit-withdraw.md can replace code tags with LaTex as well.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with rfcs/0020-ckb-consensus-protocol/0020-ckb-consensus-protocol.md and rfcs/0023-dao-deposit-withdraw/0023-dao-deposit-withdraw.md, reviewing the existing formula images and code tags. Replace the specified mathematical content with inline LaTeX while preserving the RFC meaning and formatting, then verify both documents render correctly on GitHub and both checklist items are complete.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- latex, markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100