Skip to content

docs(readme): align to Turing Pi family README convention#81

Merged
jfreed-dev merged 1 commit into
mainfrom
docs/readme-family-align
Jun 23, 2026
Merged

docs(readme): align to Turing Pi family README convention#81
jfreed-dev merged 1 commit into
mainfrom
docs/readme-family-align

Conversation

@jfreed-dev

Copy link
Copy Markdown
Member

Conform to the shared README convention:

  • Add the canonical Part of the Turing Pi cluster stack header callout with sibling buttons (provider → ansible → rk1) at the top.
  • Vendor the missing button SVGs (btn_terraform_provider_turingpi, btn_turing_ansible_cluster) locally — byte-identical (md5-verified) to the canonical set in turing-rk1-cluster. This also fixes the missing ansible cross-link.
  • Add a ## Contents TOC.
  • Unify the two Quick Start - X headings into one ## Quick Start with Talos / K3s subsections.
  • Rename RequirementsPrerequisites.
  • Drop the now-redundant bottom Related Projects section (covered by the header).

Conform to the shared README convention (freed-dev-llc/.github):
- add the canonical 'Part of the Turing Pi cluster stack' header callout
  with sibling buttons (provider, ansible, rk1) at the top
- vendor the missing btn_terraform_provider_turingpi / btn_turing_ansible_cluster
  SVGs locally (byte-identical to the canonical set in rk1-cluster)
- add a Contents TOC
- unify the two 'Quick Start - X' sections into one Quick Start with
  Talos / K3s subsections
- rename Requirements -> Prerequisites
- drop the bottom Related Projects section (now in the header)
@jfreed-dev jfreed-dev merged commit ada2dd6 into main Jun 23, 2026
@jfreed-dev jfreed-dev deleted the docs/readme-family-align branch June 23, 2026 15:15
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.

1 participant