Add SpecNode DocC and self package spec#1
Merged
Conversation
There was a problem hiding this comment.
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 describingspecnode.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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
Goals
specnode.core.Summary
specpm.yamlandspecs/specnode.spec.yamlcovering SpecNode capabilities and boundaries.Scope
Validation
Commands run:
Risk Notes
main; this PR does not add runtime behavior.