refactor(template): slim scaffolded README, clarify use_docs#323
Merged
Conversation
Member
Author
|
This change is part of the following stack: Change managed by git-spice. |
This was referenced Jun 2, 2026
![macroscopeapp[bot]](https://avatars.githubusercontent.com/in/900172?s=60&v=4){kind=small}
ApprovabilityVerdict: Approved Template refactor introducing a new You can customize Macroscope's approvability policy. Learn more. |
Add a use_community_health_files question so OSS onboarding files
(CODE_OF_CONDUCT, CONTRIBUTING, SECURITY, issue/PR templates, FUNDING) and
their docs pages and nav entries are gated independently of project_visibility.
The default mirrors the previous behaviour ({{ project_visibility == 'public' }}),
so existing projects are unaffected on copier update. Licensing files (LICENSE,
docs/license.md) stay tied to project_visibility — a separate axis.
Refs DOT-595
Drop the generic "Branch protection" prose from the scaffolded README so a new project starts with just its title, the pre-wired badge block, and description — the part actually worth keeping. README.md is _skip_if_exists (user-owned after the first copy), so this only affects freshly generated projects. Reframes DOT-597: docs stays a simple on/off — the use_docs boolean already does exactly that, so no three-way docs_mode and no migration. Clarify the use_docs help text to spell out the full site toolchain it pulls in. Refs DOT-597
ichoosetoaccept
force-pushed
the
dot-595-community-health-toggle
branch
from
bd10e87 to
5861832
Compare
ichoosetoaccept
force-pushed
the
dot-597-slim-readme
branch
from
0e1cac2 to
f8978bb
Compare
macroscopeapp
Bot
dismissed
their stale review
Dismissing prior approval to re-evaluate f8978bb
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.
Drop the generic "Branch protection" prose from the scaffolded README so a new
project starts with just its title, the pre-wired badge block, and description —
the part actually worth keeping. README.md is _skip_if_exists (user-owned after
the first copy), so this only affects freshly generated projects.
Reframes DOT-597: docs stays a simple on/off — the use_docs boolean already does
exactly that, so no three-way docs_mode and no migration. Clarify the use_docs
help text to spell out the full site toolchain it pulls in.
Closes DOT-597
Closes #
Note
Add
use_community_health_filesflag to decouple community health files from project visibilityuse_community_health_filesboolean in copier.yml, defaulting totruefor public projects, that independently controls whether community health files (CODE_OF_CONDUCT, CONTRIBUTING, SECURITY, issue templates, etc.) are scaffolded.use_community_health_filesinstead ofproject_visibility.use_docshelp text to distinguish README-only docs from a full Zensical documentation site, as a step toward the three-way docs choice described in DOT-597.public-no-communityvariant and adds a newTestCommunityHealthFilesclass in test_template.py.🖇️ Linked Issues
Partially addresses DOT-597, which proposes a three-way
use_docschoice (none/readme/site). This PR clarifies theuse_docshelp text and decouples community health files from visibility as groundwork for that change.Macroscope summarized f8978bb.