Skip to content

README.md

Latest commit

 

History

History
105 lines (89 loc) · 4.21 KB

README.md

File metadata and controls

105 lines (89 loc) · 4.21 KB
Raw

CoreEx Docs Sync

Re-runs dotnet new coreex-ai --force, pinned to the exact CoreEx.Template version matching this project's referenced CoreEx NuGet version, to refresh the whole AI workflow asset bundle — .github/instructions/, .github/skills/, .github/prompts/, .github/agents/coreex-expert.agent.md, .claude/commands/, and the .github/docs/coreex/ docs cache — as one atomic, version-matched unit. It does not fetch anything live from GitHub main; there is no "give me unreleased docs" path. That's deliberate — instructions/skills (behaviour) and the docs cache (reference material) must always describe the same release, and a live fetch can't guarantee that.

When to run

  • After bumping the CoreEx NuGet version — refreshes the whole bundle to match.
  • When coreex-expert recommends it — the agent compares .github/docs/coreex/manifest.txt's coreex-version against the project's actually-referenced CoreEx version each session and flags a mismatch (or a missing manifest).

There is no age-based ("stale after N days") trigger anymore — staleness is purely a version mismatch, since refreshing now means "re-install the matching release," not "re-fetch main and hope it lines up."

Do not run this inside the CoreEx repository itself — the docs are already present locally at samples/docs/ and src/*/AGENTS.md, and there is no NuGet-referenced version to pin to.

After a refresh that adds/removes/renames a skill, restart your AI client (not just start a new session) — most clients load their skill catalog once at startup, so a newly added or renamed skill folder under .github/skills/coreex-*/ may not show up until the app itself is restarted.

How to invoke

Claude Code:

/coreex-docs-sync

GitHub Copilot Chat:

#file:.github/skills/coreex-docs-sync/SKILL.md  sync the CoreEx docs

No arguments required.

What gets refreshed

.github/instructions/*.instructions.md
.github/skills/coreex-*/                 ← 23 skills: bootstrap, scaffold, docs-sync, 16 L1 and four L2
.github/prompts/*.prompt.md
.github/agents/coreex-expert.agent.md
.github/coreex-ai-workflows.md
.claude/commands/**
.github/docs/coreex/
  manifest.txt                             ← coreex-version, stamped by the template — not hand-written
  local-dev.md
  layers.md
  patterns.md
  contracts-layer.md
  domain-layer.md
  application-layer.md
  infrastructure-layer.md
  hosts-layer.md
  testing.md
  tooling.md
  aspire.md
  application-scaffolding-guide.md
  agents/
    CoreEx.md                            ← one guide per package, always present
    CoreEx.AspNetCore.md
    CoreEx.AspNetCore.NSwag.md
    CoreEx.Azure.Messaging.ServiceBus.md
    CoreEx.Caching.FusionCache.md
    CoreEx.CodeGen.md
    CoreEx.Cosmos.md
    CoreEx.Data.md
    CoreEx.Data.GraphQL.md
    CoreEx.Database.md
    CoreEx.Database.Postgres.md
    CoreEx.Database.SqlServer.md
    CoreEx.DomainDriven.md
    CoreEx.EntityFrameworkCore.md
    CoreEx.Events.md
    CoreEx.RefData.md
    CoreEx.UnitTesting.md
    CoreEx.Validation.md

All of the above are part of the one dotnet new coreex-ai --force bundle — none are fetched or written independently. All 18 package guides are always present regardless of which packages the project currently references, so the expert can recommend adopting a new one with full knowledge of what it offers; it reads the project's actual package references live each session (no longer cached) to tell "already in use" from "you'd need to add this."

Reference

  • SKILL.md — full detail on the version-pinned refresh mechanism, guardrails (--force scoping, orphan files), and the manifest format.
  • CoreEx Expert agent README — how the agent uses the cache and when it flags a version mismatch.