Skip to content

feat(docs): add workflow to publish s2-docs markdown to orphan branch#701

Merged
GarthDB merged 3 commits intomainfrom
feat/docs-publish-s2-docs-markdown
Feb 12, 2026
Merged

feat(docs): add workflow to publish s2-docs markdown to orphan branch#701
GarthDB merged 3 commits intomainfrom
feat/docs-publish-s2-docs-markdown

Conversation

@GarthDB
Copy link
Member

@GarthDB GarthDB commented Feb 12, 2026

Add GitHub Actions workflow to publish docs/s2-docs markdown files to a docs-markdown orphan branch for chatbot indexing.

This is Phase 1 of publishing markdown content - Phase 2 will add markdown-generator output alongside s2-docs content in PR #696.

Changes

  • Added .github/workflows/publish-markdown.yml workflow
  • Workflow triggers on pushes to docs/s2-docs/**, after successful Release workflows, and on manual dispatch
  • Publishes only *.md files from docs/s2-docs/ to the docs-markdown orphan branch under s2-docs/

Orphan Branch Layout

After this PR merges, the docs-markdown branch will contain:

docs-markdown (orphan branch)
└── s2-docs/
    ├── INDEX.md
    ├── README.md
    ├── components/
    ├── designing/
    ├── developing/
    ├── fundamentals/
    └── support/

Phase 2 (in PR #696) will add components/, tokens/, and registry/ directories alongside s2-docs/.

- Add js-yaml dependency to actually parse YAML and catch syntax errors
- Fix improperly indented field names (related_components, parent_category)
- Fix escaped underscores in field names
- Update validation to catch YAML parsing errors before other checks
- Fixed 86 markdown files with YAML frontmatter issues
Add GitHub Actions workflow to publish docs/s2-docs markdown files to
a docs-markdown orphan branch for chatbot indexing. This is Phase 1
of publishing markdown content - Phase 2 will add markdown-generator
output alongside s2-docs content in PR #696.
@changeset-bot
Copy link

changeset-bot bot commented Feb 12, 2026

⚠️ No Changeset found

Latest commit: 804caab

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@GarthDB
Copy link
Member Author

GarthDB commented Feb 12, 2026

Run report for 804caabc

Total time: 6.9ms | Comparison time: 0s | Estimated loss: 6.9ms (100.0% slower)

Action Time Status Info
🟩 SyncWorkspace 6.8ms Passed
Touched files
.github/workflows/publish-markdown.yml

@GarthDB GarthDB merged commit ef5c22c into main Feb 12, 2026
3 checks passed
@GarthDB GarthDB deleted the feat/docs-publish-s2-docs-markdown branch February 12, 2026 21:32
GarthDB added a commit that referenced this pull request Feb 12, 2026
Remove the orphan branch workflow since the chatbot supports
subdirectories directly. The chatbot can index:
https://github.com/adobe/spectrum-design-data/tree/main/docs/s2-docs

Reverts #701
GarthDB added a commit that referenced this pull request Feb 12, 2026
Remove the orphan branch workflow since the chatbot supports
subdirectories directly. The chatbot can index:
https://github.com/adobe/spectrum-design-data/tree/main/docs/s2-docs

Reverts #701
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