PEtab-dev / PEtab-dev/petab_sciml
Documentation TODOs
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 11
- Forks
- 4
- PR merge metrics
- No merged PRs in 30d
Description
- correct the whitespace in tables from the markdown->RST conversion.
- correct the links in format.rst
- read over all documentation and check for consistency with new format decisions
- store tables outside RST for maintainability, e.g. like https://github.com/PEtab-dev/PEtab/tree/main/doc/src
- delete outdated
/docsdirectory with old markdown docs - move docs for "hybridization types" out of the "hybridization table", since the type is not defined in the table, but rather the PEtab YAML extension section.
- fix "tip" boxes in format.rst
- remove old
docsdirectory - update README and repo short description to point to docs
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
Review the remaining unchecked task and compare the current RST documentation with the table organization in the linked PEtab example. Start with the documentation files referenced in the checklist, including format.rst and README, and verify that tables are maintained outside RST while the documentation links and descriptions remain consistent.
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
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100