Skip to content

Scaffold the standard norikit project structure#1

Merged
Eiluviann merged 1 commit into
mainfrom
scaffold-standard-structure
May 31, 2026
Merged

Scaffold the standard norikit project structure#1
Eiluviann merged 1 commit into
mainfrom
scaffold-standard-structure

Conversation

@Eiluviann

Copy link
Copy Markdown
Contributor

What

Builds the empty template repo out into the full norikit project scaffold — the standard structure every new project starts from. Uses stack-agnostic placeholders so it fits whatever language/stack a tool chooses.

Why

norikit/norikit/ai-docs/new-project.md instructs new projects to "create the repo from the template scaffold." Until now the template held only a LICENSE, so that instruction couldn't be followed. This makes it real, and keeps the structure consistent with ai-docs/project-structure.md.

Contents

  • README.md — branding skeleton (badges, light/dark hero <picture>, WIP note, {{TOKENS}})
  • CLAUDE.md — agent front door pointing at ai-docs/, standing rules (keep KB current; always branch/PR; worktree sync-first)
  • TEMPLATE.md — how-to-use + placeholder map; instructs the bootstrapper to replace tokens and delete it
  • ai-docs/ — knowledge base: index + decisions/architecture/open-questions/status/glossary, with the D#/Q# ID scheme and maintenance protocol
  • tasks/README.md — board + full task.md frontmatter schema
  • .github/workflows/ci.yml — graceful, self-activating CI (steps skip with ::notice:: until a build manifest / lint config exists)
  • .github/dependabot.ymlgithub-actions ecosystem live + commented language placeholders
  • Sources/ + Tests/ orientation READMEs, .gitignore, assets/ placeholder

License unchanged (AGPL-3.0).

Verification

  • All scaffold files are placeholder/skeleton content — no product code.
  • CI is designed to pass on this empty scaffold (every build/test/lint step is guarded and skips until its inputs exist).

🤖 Generated with Claude Code

Flesh out the previously empty template repo into the full project scaffold
described in norikit/ai-docs/project-structure.md, using stack-agnostic
placeholders so it fits any language/stack a new tool chooses.

Adds:
- README.md (branding skeleton: badges, hero <picture>, WIP note, {{TOKENS}})
- CLAUDE.md (agent front door -> ai-docs/, standing rules, worktree sync-first)
- TEMPLATE.md (how-to-use + placeholder map; self-deletes after bootstrap)
- ai-docs/ knowledge base: README index + decisions/architecture/open-questions/
  status/glossary, with the D#/Q# ID scheme and maintenance protocol
- tasks/README.md (board + task.md frontmatter schema)
- .github/workflows/ci.yml (graceful, self-activating: steps skip until inputs exist)
- .github/dependabot.yml (github-actions live + commented language placeholders)
- Sources/ + Tests/ READMEs, .gitignore, assets/ placeholder

License unchanged (AGPL-3.0).
@Eiluviann
Eiluviann merged commit 4cdb6aa into main May 31, 2026
2 checks passed
@Eiluviann
Eiluviann deleted the scaffold-standard-structure branch May 31, 2026 06:05
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.

1 participant