Skip to content

Add SpecNode DocC and self package spec#1

Merged
SoundBlaster merged 2 commits into
mainfrom
codex/specnode-baseline
Apr 27, 2026
Merged

Add SpecNode DocC and self package spec#1
SoundBlaster merged 2 commits into
mainfrom
codex/specnode-baseline

Conversation

@SoundBlaster
Copy link
Copy Markdown
Member

Motivation

  • Establish SpecNode documentation and package metadata so the repository can publish DocC docs and be indexed as a SpecPM package.

Goals

  • Add a DocC documentation catalog and GitHub Pages deployment workflow.
  • Add a SpecPM self-package manifest and BoundarySpec for specnode.core.
  • Document local validation commands for the new documentation/package contract.

Summary

  • Added Swift Package scaffolding for DocC generation.
  • Added DocC pages for getting started, job protocol, security model, provenance receipts, integration, and roadmap.
  • Added specpm.yaml and specs/specnode.spec.yaml covering SpecNode capabilities and boundaries.
  • Updated README and gitignore for docs build output.

Scope

  • Documentation/specification only
  • Runtime implementation
  • Tooling/tests
  • Protocol or security model change

Validation

Commands run:

git diff --check
make docs-build
/Users/egor/Development/GitHub/0AL/SpecPM/.venv/bin/python -m specpm.cli validate /Users/egor/Development/GitHub/0AL/SpecNode --json

Risk Notes

  • DocC Pages deployment runs after merge to main; this PR does not add runtime behavior.

@SoundBlaster SoundBlaster requested a review from Copilot April 27, 2026 21:01
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

This PR bootstraps SpecNode’s documentation and package metadata so the repo can publish DocC docs and be indexed/validated as a SpecPM package.

Changes:

  • Added a SpecPM self-package manifest (specpm.yaml) and a BoundarySpec describing specnode.core.
  • Added Swift Package scaffolding plus a DocC catalog/pages to generate navigable documentation.
  • Added local/CI tooling for DocC builds and a GitHub Pages deployment workflow.

Reviewed changes

Copilot reviewed 15 out of 17 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
specs/specnode.spec.yaml Introduces the BoundarySpec contract for specnode.core, including capabilities, constraints, and evidence bindings.
specpm.yaml Adds the SpecPM package manifest referencing the BoundarySpec and indexing provided capabilities.
Sources/SpecNode/specnode.swift Adds a minimal public symbol to anchor DocC generation for the SpecNode module.
Sources/SpecNode/Documentation.docc/SpecNode.md Adds the DocC landing page and topic structure for the documentation site.
Sources/SpecNode/Documentation.docc/GettingStarted.md Documents local DocC build steps and intended runtime CLI shape.
Sources/SpecNode/Documentation.docc/JobProtocol.md Adds DocC content for the typed job protocol and example envelopes.
Sources/SpecNode/Documentation.docc/SecurityModel.md Adds DocC content describing trust boundaries, threats, and MVP controls.
Sources/SpecNode/Documentation.docc/ProvenanceReceipts.md Adds DocC content for provenance/usage receipts and staged signing roadmap.
Sources/SpecNode/Documentation.docc/SpecGraphSpecPMIntegration.md Documents how SpecNode interfaces with SpecGraph and SpecPM control planes/providers.
Sources/SpecNode/Documentation.docc/Roadmap.md Adds DocC roadmap phases and deliverables for SpecNode’s progression.
Sources/SpecNode-docs/main.swift Adds a small executable target used for the Swift package’s doc tooling scaffolding.
README.md Links the published DocC site and documents local doc build command; notes specpm.yaml in layout.
Package.swift Adds Swift Package definition and DocC plugin dependency for doc generation.
Package.resolved Pins Swift-DocC plugin and related dependency versions for reproducible builds.
Makefile Adds docs-build target to generate static DocC output into .docc-build/.
.gitignore Ignores SwiftPM build output (.build/) and DocC build output (.docc-build/).
.github/workflows/docs.yml Adds GitHub Actions workflow to build DocC on PRs and deploy to GitHub Pages on merges to main.

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

Comment thread specs/specnode.spec.yaml
@SoundBlaster SoundBlaster merged commit 9b60467 into main Apr 27, 2026
2 checks passed
@SoundBlaster SoundBlaster deleted the codex/specnode-baseline branch April 27, 2026 21:08
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