Declutter the project root#676
Merged
Merged
Conversation
The root policy.yaml was a byte-for-byte duplicate of examples/get-weather-js/policy.yaml and was not loaded by any code (the run-get-weather Just target uses --component-dir ./examples/get-weather-js). Drop it and its now-redundant .dockerignore entry to declutter the project root. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Relocate the link-checker config out of the project root into .config/ to declutter the root. Update the lychee-action invocation in rust.yml to point at the new path. The link checker job is unchanged otherwise. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…butes - Remove Claude.md: a mis-cased (Linux-invisible) one-line pointer to AGENTS.md, which is now natively supported. - Move docker-compose.example.yml into docs/deployment/ (it had no references) and link it from docker.md so it stays discoverable. - Move .gitattributes to .github/.gitattributes with the pattern rebased to workflows/*.lock.yml; git check-attr confirms identical behavior. build.rs and RELEASE.md stay at root: build.rs is consumed via root-relative links (.github/workflows, Formula/, winget/). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…onfig - Remove root audit.toml: it is a dead duplicate. cargo-audit only reads .cargo/audit.toml (the commit that added it, 74c19a8, explicitly calls .cargo/audit.toml 'the correct location'). Content was identical. - Move _typos.toml and deny.toml into .config/ and point CI at them (typos action 'config:' input; 'cargo deny check --config'). Verified empirically: cargo deny loads .config/deny.toml (warns + falls back to defaults only when the path is missing), and typos --config .config/_typos.toml passes clean while bare typos reports 1397 findings. - Update .dockerignore: drop audit.toml, fold _typos.toml/deny.toml into a single .config entry. Kept at root with proof: rustfmt.toml (rustfmt reads root, ignores .config/ — verified via --print-config) and rust-toolchain.toml (rustup override discovery, no .config/ support). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The project root had accumulated ~27 loose files, several of which were dead duplicates or configs that don't actually need root placement. This trims the root by removing orphaned files and relocating tool configs into
.config/, verifying each tool still picks up its config.Removed (dead/orphaned):
policy.yaml- byte-identical duplicate ofexamples/get-weather-js/policy.yaml, not loaded by any codeaudit.toml- inert duplicate;cargo auditonly reads.cargo/audit.toml(which is unchanged and still suppresses the same advisories)Claude.md- a mis-cased one-line pointer toAGENTS.md, which is now natively supportedRelocated:
lychee.toml,_typos.toml,deny.toml->.config/(CI updated: typos actionconfig:input andcargo deny check --config)docker-compose.example.yml->docs/deployment/(now linked fromdocker.md).gitattributes->.github/.gitattributeswith the pattern rebased;git check-attrconfirms identical behaviorKept at root (verified necessary):
build.rs(consumed viainclude!of the generatedbuilt.rs),RELEASE.md(root-relative links into.github/,Formula/,winget/), andrustfmt.toml/rust-toolchain.toml(rustfmt/rustup only discover them at root, confirmed empirically).Note for reviewers:
cargo denyandtyposnow require the--configflag for local runs since their configs moved out of the default discovery path; CI passes the flag explicitly and both were run locally against the relocated configs to confirm they pass.