Skip to content

Initial implementation for the template with the targeted scope fully implemented#1

Merged
markurtz merged 4 commits intomainfrom
feature/initial-imp
May 1, 2026
Merged

Initial implementation for the template with the targeted scope fully implemented#1
markurtz merged 4 commits intomainfrom
feature/initial-imp

Conversation

@markurtz
Copy link
Copy Markdown
Owner

@markurtz markurtz commented May 1, 2026

No description provided.

@markurtz markurtz requested a review from Copilot May 1, 2026 12:44
@markurtz markurtz self-assigned this May 1, 2026
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Introduces an initial “Apache 2.0 template repository” skeleton, including a documentation site (MkDocs Material), CI/CD workflow scaffolding, and baseline community/project files to standardize new project bootstrapping.

Changes:

  • Adds a repo bootstrap script to replace core template placeholders across the repository.
  • Adds MkDocs-based documentation structure (pages, assets, requirements, and config) plus LLM-oriented docs indexes.
  • Adds GitHub Actions CI/CD workflow scaffolding (development/main/nightly/weekly/release and reusable workflows) and repo governance templates.

Reviewed changes

Copilot reviewed 62 out of 67 changed files in this pull request and generated 9 comments.

Show a summary per file
File Description
tests/unit/.gitkeep Adds placeholder to keep unit test directory in VCS.
tests/integration/.gitkeep Adds placeholder to keep integration test directory in VCS.
tests/e2e/.gitkeep Adds placeholder to keep e2e test directory in VCS.
src/{{project_name}}/.gitkeep Adds placeholder to keep templated source directory in VCS.
scripts/bootstrap.sh Adds a bootstrapper to replace template placeholders across files.
scripts/README.md Documents scripting standards and usage guidance.
mkdocs.yml Adds MkDocs Material configuration, nav, and template variables.
llms.txt Adds llms.txt index for LLM-friendly documentation discovery.
llms-full.txt Adds concatenated documentation bundle for LLM consumption.
examples/README.md Adds examples directory guidance and contribution pattern.
docs/stylesheets/extra.css Adds stub custom CSS entrypoint for MkDocs.
docs/scripts/extra.js Adds stub custom JS entrypoint for MkDocs.
docs/requirements.txt Adds Python dependencies required to build docs locally/CI.
docs/reference/index.md Adds placeholder reference landing page and guidance for generated docs.
docs/index.md Adds docs homepage (hero layout + “What’s Included” sections).
docs/guides/index.md Adds guides landing page with placeholder guide cards.
docs/getting-started/workflows.md Adds placeholder workflow/user-story documentation.
docs/getting-started/quickstart.md Adds quickstart page scaffold with placeholders.
docs/getting-started/installation.md Adds installation page scaffold with placeholders.
docs/getting-started/index.md Adds getting-started section landing page.
docs/examples/index.md Adds docs “Examples” landing page scaffold.
docs/community/support.md Includes root SUPPORT.md into docs via snippets.
docs/community/security.md Includes root SECURITY.md into docs via snippets.
docs/community/index.md Adds community landing page (contributing/setup/CoC/security/support).
docs/community/developing.md Includes root DEVELOPING.md into docs via snippets.
docs/community/contributing.md Includes root CONTRIBUTING.md into docs via snippets.
docs/community/code-of-conduct.md Includes root CODE_OF_CONDUCT.md into docs via snippets.
docs/community/agents.md Includes root AGENTS.md into docs via snippets.
docs/assets/branding/user-flow-light.svg Adds placeholder light-mode architecture/user flow diagram asset.
docs/assets/branding/user-flow-dark.svg Adds placeholder dark-mode architecture/user flow diagram asset.
docs/assets/branding/logo-light.svg Adds placeholder light-mode logo asset.
docs/assets/branding/logo-dark.svg Adds placeholder dark-mode logo asset.
docs/README.md Adds documentation contributor guide and local build instructions.
docker-compose.yml Adds docker-compose template with app + optional Postgres service.
SUPPORT.md Adds support policy and support channels template.
SECURITY.md Adds security policy and vulnerability disclosure template.
README.md Replaces minimal README with full template README + badges/links/placeholders.
NOTICE Adds Apache NOTICE template with placeholders.
Dockerfile Adds multi-stage Dockerfile template (builder + runtime).
DEVELOPING.md Adds developer setup guide including CI/CD architecture overview.
CONTRIBUTING.md Adds contribution guidelines template.
CODE_OF_CONDUCT.md Adds Contributor Covenant-based code of conduct template.
CITATION.cff Adds citation metadata template.
AGENTS.md Adds AI agent instructions and repo constraints template.
.gitignore Adds comprehensive multi-language ignore defaults.
.github/workflows/weekly.yml Adds scheduled weekly housekeeping workflow using reusable components.
.github/workflows/release.yml Adds tag-triggered release workflow using reusable components.
.github/workflows/pr_comment.yml Adds workflow_run-based PR status commenter.
.github/workflows/nightly.yml Adds scheduled nightly workflow using reusable components.
.github/workflows/main.yml Adds post-merge CI workflow using reusable components.
.github/workflows/development_cleanup.yml Adds PR-close cleanup for versioned docs previews.
.github/workflows/development.yml Adds PR CI workflow (quality/security/tests/docs/build).
.github/workflows/_tests.yml Adds reusable test runner workflow scaffold.
.github/workflows/_security.yml Adds reusable security audit workflow scaffold (TruffleHog + SCA placeholder).
.github/workflows/_quality.yml Adds reusable quality gate workflow scaffold.
.github/workflows/_publish.yml Adds reusable publish workflow scaffold.
.github/workflows/_link-check.yml Adds reusable markdown link checker workflow.
.github/workflows/_docs.yml Adds reusable MkDocs+Mike deploy workflow scaffold.
.github/workflows/_build_package.yml Adds reusable package build workflow scaffold.
.github/workflows/_build_container.yml Adds reusable container build workflow scaffold.
.github/dependabot.yml Adds Dependabot configuration for GitHub Actions updates (others commented).
.github/PULL_REQUEST_TEMPLATE.md Adds PR template with checklists and AI usage section.
.github/ISSUE_TEMPLATE/feature_request.yml Adds feature request issue form template.
.github/ISSUE_TEMPLATE/bug_report.yml Adds bug report issue form template.
.github/CODEOWNERS Adds CODEOWNERS template mapping major areas to maintainers.
.env.example Adds extensive environment variable template (app/db/infra/etc.).
.editorconfig Adds EditorConfig defaults across common file types.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread .github/workflows/development.yml
Comment thread .github/workflows/_security.yml
Comment thread .github/workflows/_link-check.yml Outdated
Comment thread docs/scripts/extra.js Outdated
Comment thread scripts/bootstrap.sh
Comment thread mkdocs.yml
Comment thread .github/workflows/development.yml Outdated
Comment thread .github/workflows/_quality.yml
Comment thread .github/workflows/_tests.yml
@markurtz markurtz merged commit b224cd2 into main May 1, 2026
10 checks passed
@markurtz markurtz deleted the feature/initial-imp branch May 1, 2026 13:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants