oasisprotocol / oasisprotocol/docs
Manually curate page descriptions for pages linked as doc cards
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 15
- Forks
- 46
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 1
Description
After #180, Markdown page descriptions are generated automatically by taking the first conten-ful line.
Since we are using 80-character line wrapping and we start the guides with introductory "This guide will teach you ...", this doesn't work so well.
An example:
A better manually curated description would be something like:
Guide on transferring ROSE tokens from consensus into EVM-compatible ParaTimes
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 by reviewing the page-description behavior introduced in issue #180 and locate the Markdown pages used as doc cards. Replace unsuitable automatically derived descriptions with manually curated descriptions such as the ROSE-to-EVM example, then verify the affected cards display the intended text.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100