Skip to content

Document how TEC uses this repo - #46

Draft
sdokus wants to merge 4 commits into
mainfrom
docs/how-tec-uses-this-repo
Draft

sdokus wants to merge 4 commits into
mainfrom
docs/how-tec-uses-this-repo

Conversation

@sdokus

@sdokus sdokus commented Sep 15, 2026 •

Copy link
Copy Markdown
Contributor

🎫 Ticket

N/A.

📋 Plan

N/A. Documentation only, no code change.

🗒️ Description

Adds docs/how-tec-uses-this-repo.md, a walkthrough of what this repository does for TEC: the sync mechanism and groups, every synced file and workflow, the composite actions, the release order, what a product repo needs before sync works, and which parts are TEC policy versus reusable.

It is written for readers with no TEC background. The goal is to give the LearnDash team enough context to document their own setup, so we can move toward a shared actions repo across both teams.

Modeled loosely on the shape of the LearnDash learndash-tools-template README (table of contents up top, short sections).

Feedback wanted on anything that is wrong, missing, or unclear to someone outside TEC.

🎥 Artifacts

N/A, Markdown only.

✔️ Checklist

  • There is an OpenSpec plan for this work in tec-plans, and it still describes what this PR actually does. (N/A, docs only)
  • Changelog file(s) added. (N/A, this repo has no changelog)
  • Code is covered by tests. (N/A)
  • All the required tests are passing.
  • Automated code review comments are addressed.
  • Artifacts added. (N/A)
  • Check the base branch for your PR.
  • The linked ticket includes all the information for a QA engineer to verify the work. (No ticket)
  • Pull Request is ready to be reviewed by a Human.

🤖 AI Disclosure

Was AI used for this PR [Y/n]: Y

Which model(s): Claude

In what way was AI used: Researched both repos and drafted the document.

  • I own the work being done in this PR and I have personally reviewed it before asking another human to.

@coderabbitai

coderabbitai Bot commented Sep 15, 2026

Copy link
Copy Markdown

Important

Draft PR not reviewed

Draft PRs are not automatically reviewed by default.

  • Trigger a manual review

To automatically review draft PRs, update your CodeRabbit configuration:

reviews:
  auto_review:
    drafts: true

Comment @coderabbitai help to get the list of available commands.

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