Skip to content

docs: make the docs work from this repository - #3

Merged
ValgulNecron merged 1 commit into
mainfrom
docs/gameplane-links
Nov 17, 2026
Merged

ValgulNecron merged 1 commit into
mainfrom
docs/gameplane-links

Conversation

@ValgulNecron

Copy link
Copy Markdown
Contributor

The docs still assumed they lived inside Gameplane after the split.

  • New README.md (the repo had none): what the sidecar and node worker do, where the contract and threat model live, build/test, CI and image build.
  • specs.md: note under the H1 saying which repository docs/, operator/, api/ … refer to; drop the svcutil sentence and the dangling RunHTTP mention (svcutil was deleted in the split); fix the stale cmd/main.go:80-86 pointer; test commands no longer use the Gameplane Makefile.
  • cmd/main.go: comment only, the mTLS comment named the deleted svcutil.RunHTTP; it now says a plain-HTTP server must not be used. No code change (compile-checked with GOWORK=off go build ./...).
  • .testcoverage.yml / system-deps.toml: describe the shared go-component.yaml CI instead of make cover-go-check, go.work and Makefile line numbers.
  • New AGENTS.md (+ CLAUDE.md symlink, same as Gameplane): what the repo is, how CI/images/pointer bumps work, and the Gameplane rules that apply here.

No behaviour change.


Generated by Claude Code

The docs still assumed they lived inside Gameplane: relative ../docs links,
go.work and Makefile claims, and no contributor guide. Point Gameplane paths
at the Gameplane repository, describe the shared CI, add AGENTS.md (with a
CLAUDE.md link) and, where missing, a README.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Claude <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Nov 17, 2026

Copy link
Copy Markdown

Important

  • Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 3ac46d95-f942-4368-bd92-e7566d5f91a9
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

@ValgulNecron
ValgulNecron merged commit 490ab9b into main Nov 17, 2026
6 checks passed
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