Skip to content

[FEAT] Better Collaboration Mechanisms #1668

Open

Description

@henrydingliu

We can improve our collective productivity if we had a better platform for exchanging WIP snippets. Take this comment from @scks1. I had to separately create the same snippets based on the descriptions to understand the points made in the comment. It would be infinitely faster if we could easily share notebooks.

Since we have per-PR RTD builds, one idea is to create a temp folder under docs, and WIP snippets are saved in a notebook in this folder for each PR. we then periodically clean out this folder or clean it out in each PR.

@casact/chainladder-maintainers thoughts?

Activity

  1. scks1 commented on Nov 18, 2026

    @scks1
    Contributor

    Thanks for opening this, and sorry for the extra work on #1610. I support the idea. From now on my comments will carry a collapsed snippet for every printed value, and I'll run each snippet as written before I post.

    Two notes on docs/temp from the current docs config.

    1. _config.yml sets execute_notebooks: force with a 180 second timeout, and RTD regenerates conf.py from it in pre_build. So each PR build would rerun the temp notebooks against that PR's code. The outputs can't go stale, but each notebook adds its run time to every build of that PR. Snippets on the sample data should stay well under the limit.
    2. _toc.yml lists every page, so a temp notebook outside it would still build but Sphinx would warn that the page isn't in any toctree. An orphan: true front matter cell in each temp notebook might keep it out of the navigation without the warning. I haven't tried that on this build.

    A check on main that docs/temp holds nothing but a README could handle the cleanup.

    (This comment was written with Árbol, an AI assistant, under my direction.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    Priority

    None yet

    Scope

    None yet

    Effort

    None yet

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions