nv-tlabs / nv-tlabs/cascade-devkit
docs(notebooks): reconcile committed-output policy
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 1
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
The README Development section says notebooks are committed without embedded outputs, but the later documented policy in the changelog (PR #112) and the current notebook artifacts retain executed outputs. This contradiction surfaced while regenerating notebook 02 for the strict temporal operator work. Please establish one canonical policy and update the README/workflow guidance accordingly. No runtime behavior is affected.
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 with the README Development section, then compare its notebook-output statement with the changelog policy from PR #112 and the current notebook artifacts. Establish one canonical policy and update the README and workflow guidance so they agree, with no runtime changes required.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter-notebook
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100