Skip to content

WIP: Kita Html v5.0.0#468

Draft
arthurfiorette wants to merge 73 commits intomasterfrom
next
Draft

WIP: Kita Html v5.0.0#468
arthurfiorette wants to merge 73 commits intomasterfrom
next

Conversation

@arthurfiorette
Copy link
Member

This pull request introduces significant improvements to CI/CD workflows, documentation tooling, and package configuration. The CI pipeline now supports broader Node.js versions and operating systems, adds a dedicated docs deployment job, and optimizes build caching. Documentation quality is enhanced with new agent and skill files enforcing strict writing and structuring conventions. Several package changesets address test coverage, CLI reliability, and plugin improvements.

CI/CD Workflow Enhancements

  • Expanded CI matrix to cover multiple Node.js LTS versions and all major OSes, improving test coverage and reliability (.github/workflows/ci.yml).
  • Added a dedicated deploy-docs job for automatic documentation deployment to GitHub Pages on master and next branches (.github/workflows/ci.yml).
  • Introduced turbo build caching to CI and release workflows for faster builds (.github/workflows/ci.yml, .github/workflows/release.yml) [1] [2].
  • Removed the unused CodeQL workflow, streamlining CI configuration (.github/workflows/codeql.yml).

Documentation Tooling and Standards

  • Added a new docs-writer agent and two skill files (information-mapping, rspress-writing) to enforce structured writing and Rspress conventions for documentation (.claude/agents/docs-writer/CLAUDE.md, .claude/skills/information-mapping/SKILL.md, .claude/skills/rspress-writing/SKILL.md, .claude/skills/rspress-writing/style-examples.md) [1] [2] [3] [4].

Package Configuration Improvements

  • Updated .changeset/config.json to ignore additional example and docs packages in dependency updates, reducing unnecessary changes.

Package Changesets

  • Broadened and improved test suite for @kitajs/html, removed deprecated @kitajs/html/register, and initiated a major overhaul (.changeset/slimy-wolves-buy.md, .changeset/stale-shrimps-spend.md, .changeset/warm-seas-kiss.md) [1] [2] [3].
  • Improved CLI reliability, XSS detection, and multiline TSServer message support in @kitajs/ts-html-plugin (.changeset/metal-hairs-juggle.md, .changeset/metal-corners-type.md, .changeset/hip-trams-roll.md) [1] [2] [3].

- Add new Claude skill for monorepo development workflow
- Document iterative testing approach (test after each change group)
- Add pre-push checklist (format, build, test-types, test, changeset)
- Include 6 workflow examples covering common scenarios
- Update CONTRIBUTING.md with iterative workflow section
- Document debug parameter for TSLangServer in tests
- Explain tss.log file generation and console output
- Add warning about single debug instance per test file
- Update ts-html-plugin CLAUDE.md, CONTRIBUTING.md, and kita-dev-workflow skill
- Lightweight documentation index that maps concepts to files
- References official docs in packages/docs/docs/ (single source of truth)
- References package CLAUDE.md files for implementation details
- Includes quick reference for critical gotchas
- No hardcoded duplication - everything defers to documentation files
- Maps XSS errors, safety rules, Suspense, integrations, and more
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.

2 participants