Skip to content

docs: clarify repo topology and connected surfaces - #1

Merged
mdheller merged 5 commits into
mainfrom
docs/repo-topology-role-20260328
Apr 14, 2026
Merged

docs: clarify repo topology and connected surfaces#1
mdheller merged 5 commits into
mainfrom
docs/repo-topology-role-20260328

Conversation

@mdheller

@mdheller mdheller commented Apr 7, 2026

Copy link
Copy Markdown
Member

Summary

Clarifies that SourceOS is the immutable substrate in the Linux-side topology and names the adjacent integration, contract, automation, and public-surface repos.

Why

This repo is central to the stack, but the README did not yet say how it fits with the spine, contract, and commons lanes. This update makes those boundaries explicit.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the README to clarify where this repository sits in the broader SourceOS/SociOS Linux-side topology, explicitly describing its role as the immutable OS substrate and naming adjacent integration/contract/automation/public-surface repositories.

Changes:

  • Added a “Topology position” section describing this repo’s role in the stack.
  • Listed connected repositories/surfaces and clarified what is explicitly out of scope for this repo.
  • Documented intended semantic direction for publishing a substrate-focused repo descriptor referencing sourceos-spec.

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

@mdheller

mdheller commented Apr 9, 2026

Copy link
Copy Markdown
Member Author

@copilot fix failed checks and conflicts

Copilot AI commented Apr 9, 2026

Copy link
Copy Markdown
Contributor

@copilot fix failed checks and conflicts

Fixed in bb2adda. The CI was failing due to yamllint errors in spec/volumes/volumes.yml — alignment spaces after colons and commas (e.g. Desktop: {path: "~/Desktop", policy:) violated the [colons] and [commas] rules. Removed the extra alignment padding. No merge conflicts were found in the branch.

@mdheller

Copy link
Copy Markdown
Member Author

@copilot Fix checks and conflicts

Copilot AI and others added 2 commits April 14, 2026 11:59
…le-20260328

Co-authored-by: mdheller <21163552+mdheller@users.noreply.github.com>

Copilot AI commented Apr 14, 2026

Copy link
Copy Markdown
Contributor

@copilot Fix checks and conflicts

Fixed in 5dff5e8. Changes made:

  • Merged origin/main (no conflicts — adds upstream pointer docs for semantic-search)
  • Added .markdownlint.json disabling MD013 line-length, which is impractical to enforce in a technical docs repo with code references
  • Fixed MD041 (first-line must be H1): CONTRIBUTING.md, SECURITY.md, docs/BOUNDARIES.md
  • Fixed docs/compression-commons/v0/README.md: file contained literal \n escape sequences instead of actual newlines; corrected and added blank line around list (MD032)
  • Fixed MD022/MD032 (blank lines around headings/lists): caps/semantic-search-bi/docs/README.md, docs/adr/0001-silverblue-toolbx-flatpak-podman.md, docs/semantic-search/README.md, docs/semantic-search/UPSTREAM.md

Both markdownlint "**/*.md" and yamllint -c .yamllint.yml . now pass cleanly.

@mdheller
mdheller merged commit be3a7ef into main Apr 14, 2026
2 checks passed
@mdheller
mdheller deleted the docs/repo-topology-role-20260328 branch July 4, 2026 16:07
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.

3 participants