Skip to content

docs: remove old dsl doc#1789

Merged
hexqi merged 1 commit intoopentiny:developfrom
chilingling:docs/remove-old-dsl-docs
Mar 19, 2026
Merged

docs: remove old dsl doc#1789
hexqi merged 1 commit intoopentiny:developfrom
chilingling:docs/remove-old-dsl-docs

Conversation

@chilingling
Copy link
Copy Markdown
Member

@chilingling chilingling commented Mar 19, 2026

English | 简体中文

PR

PR Checklist

Please check if your PR fulfills the following requirements:

  • The commit message follows our Commit Message Guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • Built its own designer, fully self-validated

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

Background and solution

【变更说明】移除旧的 DSL 文档。(后端 DSL 的接口文档)

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

  • Documentation
    • Removed DSL code generation documentation from backend API reference materials.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Mar 19, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Mar 19, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: da41ca3c-afec-4fa8-a517-e08eed314517

📥 Commits

Reviewing files that changed from the base of the PR and between 95ec88b and f6ea146.

📒 Files selected for processing (3)
  • docs/README.md
  • docs/api/backend-api/dsl-code-generation.md
  • docs/catalog.json
💤 Files with no reviewable changes (2)
  • docs/README.md
  • docs/api/backend-api/dsl-code-generation.md

Walkthrough

Documentation for DSL code generation was removed from the README and its corresponding API documentation file was deleted. Additionally, the JSON catalog file was reformatted to expand single-line entries into multi-line objects without altering content.

Changes

Cohort / File(s) Summary
Documentation Removal
docs/README.md, docs/api/backend-api/dsl-code-generation.md
Removed table of contents entry and deleted the entire DSL code generation API documentation file (previously documented /generateCode endpoint and response structure).
Catalog Formatting
docs/catalog.json
Reformatted JSON structure by expanding single-line article entries into multi-line objects across multiple sections. Removed one blank line before "更新日志" section and trailing newline; no content additions or removals.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A rabbit hops through docs with care,
Sweeping out what isn't there,
DSL codes fade to history's call,
While JSON stands formatted tall!
The catalog breathes with proper space,
Documentation finds its place. ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: remove old dsl doc' directly and accurately describes the main change: removal of DSL documentation files. It is clear, specific, and matches the actual changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
📝 Coding Plan
  • Generate coding plan for human review comments

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@chilingling chilingling changed the title docs: remove oldd dsl doc docs: remove old dsl doc Mar 19, 2026
@chilingling chilingling force-pushed the docs/remove-old-dsl-docs branch from fe2e9f3 to f6ea146 Compare March 19, 2026 09:55
@hexqi hexqi merged commit cc8c643 into opentiny:develop Mar 19, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants