PEtab-dev / PEtab-dev/petab_sciml

Documentation TODOs

Open
#23 1 comment 0 reactions 0 assignees View on GitHub

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 /docs directory 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 docs directory
  • update README and repo short description to point to docs

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.