pymc-labs / pymc-labs/CausalPy
Docs: Improve cross-links and navigation for sensitivity checks docs (follow-up #749)
Open
Nobody has claimed this yet.
documentation
OSS_PRODUCT
- Dominant language
- Python
- Stars
- 1.2k
- Forks
- 115
- Avg merge
- 6d 1h
- Merged PRs (30d)
- 11
Description
Follow-up to #749.
Objective
Ensure users can find sensitivity-check docs from primary entry points.
Scope
- Add links/callouts from notebook index, workflow docs, and API docs
- Add lightweight pointers in notebooks that do not need full sensitivity sections
Acceptance criteria
- Main docs entry points link to central sensitivity docs
- Navigation is coherent and avoids duplicate long-form content
Parent issue: #785
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
Locate the notebook index, workflow docs, API docs, notebooks, and central sensitivity docs referenced in the scope. Review how existing links and callouts are organized, then connect the main entry points to the central sensitivity documentation and add lightweight notebook pointers without duplicating long-form content. Done means the acceptance criteria are met and navigation is coherent.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100