Documentation data
Nobody has claimed this yet.
- Dominant language
- Less
- Stars
- 680
- Forks
- 442
- PR merge metrics
- No merged PRs in 30d
Description
One of my "design" goals for the new site is to look for opportunities to make data more reusable, whenever possible. For example, our CHANGELOG will be formatted as YAML so that it can be parsed and used in templates. This allows the changelog to be rendered as markdown, HTML, or even pulled down from the GitHub API and consumed by some other application or lib.
I also believe that - if executed well - this will make the site more accessible, scalable and maintainable.
- changelog: version (object|key), date (string), changes (associative array)
- language features (todo)
Related
Contributor guide
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
The issue names no files or tests; start by reviewing the proposed changelog fields and the related Docs API issue. Clarify the scope for changelog and language-feature data, then document an agreed schema that supports the stated rendering and API uses.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github, markdown, yaml
- Domain
- content, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100