Hysen Labs
Open-source project
SSWConsulting/SSW.Rules.Content avatar
SSWConsulting

SSW.Rules.Content

Secret ingredients to quality software

62 stars196 forksMDXCC0-1.0
DEEP OPEN-SOURCE ANALYSIS

SSW Rules content holds the markdown source for software best practices

A repository of SSW's coding and process rules as markdown, built and deployed through GitHub Actions.

What the repository contains

SSW.Rules.Content is the data behind SSW Rules, described in the README as the rules in markdown form. The project invites contributors to add best practices to SSW Rules, and it frames the content as the secret ingredients to quality software. Rather than being a tool or a library, this repository is the authored body of rules that a separate code repository renders into a static site. Each rule lives in the rules folder and each category lives in the categories folder. A rule has its own folder containing a rule.md file plus images and assets. Rules are organized into categories, and a rule can belong to several categories at once. Category pages link to rules through frontmatter data, which keeps the relationship between a category and its rules declarative instead of hardcoded in a template. This structure means the content stays portable: the same markdown can be consumed by the static site generator without the authors worrying about presentation. For someone browsing the repository, the practical content is a large set of short guidance documents on how software teams should write code, run projects, and work together, maintained as plain text that is easy to diff and review. The markdown format also means a rule can be edited in any text editor and proposed through a normal pull request, which keeps the contribution flow close to how code is changed.

How changes are built and approved

The README explains that builds run in GitHub Actions. After a rule is edited, a pull request must be merged into the main branch before the change is deployed to production. Pull requests can be approved by anyone at SSW, and the document names several people to try first, including Tiago Araujo, Brady Stroud, Adam Cogan, Luke Cook, and Brook Jeynes. Outstanding pull requests are linked from the README, and once merged the build and deploy workflow is visible in the actions tab of the companion SSW.Rules repository. GitHub Actions documentation for the projects lives in the repository wiki. This workflow keeps the rules themselves under the same review discipline as code: an edit is proposed, reviewed, merged, and only then published. The use of pull requests also gives a public history of why a rule changed, which matters for guidance that teams rely on. The named approvers show the content is curated by a specific organization rather than left fully open, while still accepting outside contributions through the pull request process. The named approvers show the content is curated by a specific organization, and the public pull request history lets readers see when and why a rule was revised.

Engine and agentic maintenance

The README notes that the rules engine is built into a static site by the code in the separate SSW Rules repository, so this content repository is the data half of a two part system. The content side supplies the markdown and assets, and the engine side turns that into the published site. The document also describes an agentic workflow: the repository uses GitHub Agentic Workflows, specifically campaigns, to assist in the ongoing maintenance of the content, with a reference to a ContentHawk documentation file for details on those campaigns and how to create them. This means the steady work of keeping rules current, such as fixing broken links or refreshing examples, can be partly driven by automated campaigns rather than solely by manual edits. The combination of markdown content, GitHub Actions deployment, and agentic maintenance points to a documentation system designed to stay alive after it is first written. For a reader, the takeaway is that SSW Rules is both a published reference and a maintained project, with this repository holding the words and the linked engine handling the presentation. The agentic campaigns described in the ContentHawk documentation suggest the rules can be maintained partly by automation, which helps the content stay current after the initial authoring effort.

Editorial conclusion

The content repository is published under the CC0-1.0 license and its most recent commit was on 2026-08-26.

DEEP OPEN-SOURCE ANALYSIS

Official sources

Community notes

Community notes