Skip to content
samatstarion edited this page May 3, 2026 · 1 revision

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

What this repository is

This is the GitHub wiki for STARIONGROUP/COMET-WebServices-Community-Edition — it is not the source code. The repository contains only Markdown pages plus images. There is no build, no test suite, no linter, and no package manifest. Pushing to origin/master publishes the wiki on GitHub.

The product being documented is the CDP4-COMET Web Services Community Edition: an ASP.NET Core 8 (moving toward .NET 10 per Roadmap.md) server implementing ECSS-E-TM-10-25A Annex A/C, backed by PostgreSQL, deployable bare-metal (Linux/Windows/macOS) or via Docker. The actual source lives in the sibling repo above; do not look for .cs, .csproj, or solution files here.

Wiki conventions

  • Navigation index: _Sidebar.md is the table of contents rendered alongside every page. Any new top-level page must be added here, otherwise it is effectively unreachable.
  • Footer: _Footer.md is the global footer.
  • Home page: Home.md is what GitHub serves at the wiki root.
  • Inter-page links use Gollum syntax, not normal Markdown links:
    • [[Page Title]] when the page slug equals the title.
    • [[Display Text|PageSlug]] when the file name differs from the desired display, e.g. [[Windows Server 2019|WindowsServer2019]], [[REST API - ICD|ICD]].
  • File naming is inconsistent across history. Both hyphens (Authentication-Authorization.md, architecture-overview.md) and underscores (PostgreSQL_Tuning.md) appear. Match the slug already referenced from _Sidebar.md rather than inventing a new convention; if you rename a page, update every [[…]] link that targets it (grep the whole repo).
  • External links within the wiki are written as [[Display|https://…]] (Gollum), not standard [text](url). Both forms render, but match the surrounding page's style.
  • Images live in images/ and windows-2019/. Reference architecture diagrams hosted on GitHub raw use the https://raw.githubusercontent.com/wiki/STARIONGROUP/COMET-WebServices-Community-Edition/... URL pattern (see Introduction.md).

Content domain reference

When editing, these are the load-bearing concepts so links and terminology stay consistent:

  • Two solution-internal projects do most of the work the docs describe: CometOrm (DAO layer; auto-generated Dao classes mirror the ECSS-E-TM-10-25 data model and inherit through to ThingDaoBaseDao) and CometServer (ASP.NET Core + Carter routing, business logic for Annex C). Auth plugs in via CometAuthentication + CometDatabaseAuthentication. VersionFileCreator generates the VERSION file. See architecture-overview.md.
  • Code-generation + partial classes is the central architectural pattern — generated DAOs are partial, hand-written supplements live in Dao/Supplemental. Don't describe the codebase as if everything is hand-written.
  • ICD.md is the REST API contract (Annex C). It is the largest and most-often-updated page (git log shows frequent "Updated ICD" commits). Treat it as the authoritative interface document.
  • Configuration / Deployment pages (Configuration.md, Docker.md, Ubuntu.md, WindowsServer2019.md, Upgrade.md) include version-specific commands and tags — when bumping versions globally, update all of them, not just one.

Working in this repo

  • No commands to run. There is nothing to build, test, or lint locally. Verify rendering by reading the Markdown or, if needed, viewing on github.com after pushing.
  • Releases on the code repo drive doc updates here. When the Web Services version bumps (see Build.md and Dockerize.md release procedures), Docker.md, Configuration.md, Ubuntu.md, WindowsServer2019.md, and Upgrade.md typically need version-string updates in lockstep.
  • Don't push without the user explicitly asking. Pushing publishes the wiki to the public GitHub site immediately.
  • The remote URL contains a credential token. Do not echo git remote -v output into chat or commits.

Clone this wiki locally