Repository navigation
chore: consolidate root-level files into .github/ and docs/ - #591
Conversation
…/, paper/, assets/ Agent-Logs-Url: https://github.com/Jebel-Quant/jquantstats/sessions/78c5ee25-dda0-4f30-b328-e9173ae08635 Co-authored-by: tschm <2046079+tschm@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Consolidates several root-level configuration, community, and documentation assets under .github/ and docs/ to reduce repository root clutter while keeping workflows and tooling functional.
Changes:
- Move
git-cliffconfig and community health files into.github/, updatinggit-cliffinvocations accordingly. - Relocate the companion paper and book assets under
docs/, updating the paper workflow and Rhiza notebook export paths. - Update README citation link to the new
.github/CITATIONS.biblocation.
Reviewed changes
Copilot reviewed 7 out of 21 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
Makefile |
Updates git-cliff invocation to use .github/cliff.toml. |
.github/workflows/rhiza_release.yml |
Updates release-notes generation to use .github/cliff.toml. |
.github/cliff.toml |
Adds git-cliff config at the new location. |
.github/workflows/paper.yml |
Updates CI build paths/working directory for docs/paper/. |
docs/paper/jquantstats.tex |
Companion paper content now under docs/paper/. |
docs/paper/jquantstats.bib |
Paper bibliography now under docs/paper/. |
.rhiza/make.d/book.mk |
Updates Marimo notebook discovery/export path to docs/book/.... |
.rhiza/.env |
Updates MARIMO_FOLDER to docs/book/marimo/notebooks. |
.github/workflows/rhiza_quality.yml |
Updates comment to reflect docs/book/marimo path. |
docs/book/marimo/notebooks/rhiza.py |
Marimo notebook now under docs/book/.... |
docs/book/marimo/notebooks/analytics_demo.py |
Analytics demo notebook now under docs/book/.... |
README.md |
Updates CITATIONS.bib link to .github/CITATIONS.bib. |
.github/CODE_OF_CONDUCT.md |
Community health file moved under .github/. |
.github/CONTRIBUTING.md |
Community health file moved under .github/. |
.github/SECURITY.md |
Community health file moved under .github/. |
.github/ROADMAP.md |
Community health file moved under .github/. |
.github/CITATIONS.bib |
Citation file moved under .github/. |
Comments suppressed due to low confidence (1)
.rhiza/make.d/book.mk:52
_book-notebooksusesfor nb in docs/book/marimo/notebooks/*.py; do ...which will iterate once with the literal*.pyif the directory exists but contains no notebooks, causing the export command to fail. Consider guarding the loop with anls .../*.py >/dev/null 2>&1check (orfind), or skipping entries when the glob doesn’t match.
@if [ -d "docs/book/marimo/notebooks" ]; then \
rm -rf docs/notebooks && mkdir -p docs/notebooks; \
for nb in docs/book/marimo/notebooks/*.py; do \
name=$$(basename "$$nb" .py); \
printf "${BLUE}[INFO] Exporting $$nb${RESET}\n"; \
abs_output="$$(pwd)/docs/notebooks/$$name.html"; \
(cd "$$(dirname "$$nb")" && uv run marimo export html --sandbox "$$(basename "$$nb")" -o "$$abs_output"); \
done; \
| @@ -1,4 +1,4 @@ | |||
| MARIMO_FOLDER=book/marimo/notebooks | |||
| MARIMO_FOLDER=docs/book/marimo/notebooks | |||
There was a problem hiding this comment.
MARIMO_FOLDER is now docs/book/marimo/notebooks, but there are still repo references to the old book/ location (e.g. .pre-commit-config.yaml has exclude: ^book/ for interrogate, and .github/secret_scanning.yml ignores book/**). To keep tooling behavior consistent after the move, those references should be updated to docs/book/... (and any user docs like docs/MARIMO.md that still instruct uv run book/marimo/...).
The book/ directory was moved to docs/book/ in the consolidation commit, but the interrogate exclude paths were not updated, causing docstring coverage to drop to 99.8%. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…ocs/notebooks/ Update all references in .env, Makefile targets, docs, workflows, and linter configs (ruff, interrogate) to point to the new location. Remove the now-empty docs/book/ directory. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Update Makefile and template.lock references accordingly. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Reduces root directory from 27 → ~19 items by relocating files that are equally functional from subdirectories.
Moves
cliff.toml.github/cliff.tomlCODE_OF_CONDUCT.md.github/CODE_OF_CONDUCT.mdCONTRIBUTING.md.github/CONTRIBUTING.mdSECURITY.md.github/SECURITY.mdROADMAP.md.github/ROADMAP.mdCITATIONS.bib.github/CITATIONS.bibbook/**docs/book/**paper/**docs/paper/**assets/*.svgdocs/assets/Reference updates
Makefile/rhiza_release.yml: add--config .github/cliff.tomltogit-cliffinvocationspaper.yml:working-directory, artifactpath,cpcommand, and path triggers updated todocs/paper/rhiza_quality.yml: comment updated todocs/book/marimo.rhiza/make.d/book.mk: notebook discovery path updated todocs/book/marimo/notebooks.rhiza/.env:MARIMO_FOLDERupdated todocs/book/marimo/notebooksREADME.md:CITATIONS.biblink updated to.github/CITATIONS.bibWarning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
astral.sh/usr/bin/curl curl -LsSf REDACTED(dns block)If you need me to access, download, or install something from one of these locations, you can either:
Original prompt
Goal
Reduce the number of files and folders at the repository root by implementing four consolidation moves. Do not touch
pyproject.toml,pytest.ini,ruff.toml,.semgrep.yml, or any other file not listed below.Changes to make
2 — Move
cliff.toml→.github/cliff.tomlcliff.tomlto.github/cliff.toml(content unchanged).cliff.tomlso tools still find it:Makefile: thechangelogtarget calls${UVX_BIN} git-cliff --output CHANGELOG.md— add--config .github/cliff.tomlto the invocation..github/workflows/rhiza_release.yml: thedraft-releasejob runsuvx git-cliff --latest --output RELEASE_NOTES.md— add--config .github/cliff.toml.3 — Move community health files →
.github/GitHub recognises
CODE_OF_CONDUCT.md,CONTRIBUTING.md,SECURITY.md, andROADMAP.mdfrom.github/just as well as from the root.CODE_OF_CONDUCT.md→.github/CODE_OF_CONDUCT.mdCONTRIBUTING.md→.github/CONTRIBUTING.mdSECURITY.md→.github/SECURITY.mdROADMAP.md→.github/ROADMAP.mdCITATIONS.bib→.github/CITATIONS.bibREADME.md(line 287):[CITATIONS.bib](https://github.com/jebel-quant/jquantstats/blob/main/CITATIONS.bib)→[CITATIONS.bib](https://github.com/jebel-quant/jquantstats/blob/main/.github/CITATIONS.bib)4 — Move
book/andpaper/underdocs/book/→docs/book/(recursively, preserving all content includingbook/marimo/notebooks/).paper/→docs/paper/(recursively; containspaper/jquantstats.bibandpaper/jquantstats.tex).book/andpaper/directories..github/workflows/paper.yml:working-directory: paper→working-directory: docs/paperpath: paper/jquantstats.pdf→path: docs/paper/jquantstats.pdfcp paper/jquantstats.pdf /tmp/jquantstats.pdf→cp docs/paper/jquantstats.pdf /tmp/jquantstats.pdf'paper/**'→'docs/paper/**'.github/workflows/rhiza_quality.yml: thedeptryjob comment mentionsbook/marimoas a folder checked — update the comment todocs/book/marimo.book/should be updated todocs/book/.5 — Move
assets/→docs/assets/The
assets/directory contains only SVG files (snapshot_1n.svg,snapshot_all.svg) used by the documentation.assets/→docs/assets/(all files).assets/directory.mkdocs.ymlif it references theassets/path (currently it does not explicitly reference it, but check for anyassetspaths in the config).README.mdfor any image links pointing toassets/and update them. CurrentlyREADME.mdline 62 referenceshttps://raw.githubusercontent.com/jebel-quant/jquantstats/main/docs/assets/dashboard.png— this already points todocs/assets/so it is fine. Check for any references to the rootassets/path and update them.Summary of files affected
cliff.toml.github/cliff.tomlCODE_OF_CONDUCT.md.github/CODE_OF_CONDUCT.mdCONTRIBUTING.md.github/CONTRIBUTING.mdSECURITY.md.github/SECURITY.mdROADMAP.md.github/ROADMAP.mdCITATIONS.bib.github/CITATIONS.bibbook/**docs/book/**paper/**docs/paper/**assets/**docs/assets/**Makefile--config .github/cliff.tomltogit-cliffcall.github/workflows/rhiza_release.yml--config .github/cliff.tomltogit-cliffcall.github/workflows/paper.ymlpaper/→docs/paper/paths and triggerREADME.mdCITATIONS.biblinkDo not modify any other files. Keep all file contents identical apart from the path updates listed above.
The following is the prior conversation context from the user's chat exploration (may be truncated):
User: .semgrep.yml should be in .github?
Assistant: Short answer: it depends on how you're using it.
The file currently lives at
.semgrep.ymlin the repo root. Here's the breakdown of both options:Option A: Keep it at
.semgrep.yml(repo root) ✅ — current location, and the Semgrep defaultSemgrep's CLI automatically discovers rule files named
.semgrep.yml(or.semgrep/) in the repo root. This is the convention Semgrep itself documents and expects. No additional configuration needed for local runs or pre-commit hooks.Option B: Move to
.github/semgrep.ymlThis is not a Semgrep convention. Semgrep will not auto-discover rules there unless you explicitly point to it (e.g., `semgrep ...
This pull request was created from Copilot chat.
💬 Send tasks to Copilot coding agent from Slack and Teams to turn conversations into code. Copilot posts an update in your thread when it's finished.