leanprover-community / leanprover-community/physlib
API maps transfers
Open
Nobody has claimed this yet.
- Dominant language
- Lean
- Stars
- 749
- Forks
- 189
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 75
Description
Historically we have used GitHub issues for API specifications (see here). However, we are turning to the use of API-map.yml.
To do this we have a number of tasks we need to do:
- Move all of the GitHub issues for APIs to API-map.yml files. (The github issues should be closed)
- Write a linter to check that the API-map.yml files have the correct format, and that any claimed result actually exists.
- Update the website API map to take account of the existence of API-map.yml.
- Write a guide on writing good API maps.
- Add a way that people can edit or suggest improvements to API maps on the website, without downloading Lean.
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
Start by reviewing the existing API issues and the API-map.yml example in Physlib/SpaceAndTime/Time/API-map.yaml, then identify how the website currently builds its API map. The issue is complete only when the migration, linter, website integration, contributor guide, and web editing or suggestion workflow are all defined and implemented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- yaml
- Domain
- api, documentation, tooling, web-dev
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Active
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100