Skip to content

feat: refine English wording for docs files: 43-50#421

Merged
hsluoyz merged 4 commits intomasterfrom
copilot/polish-docs-for-clarity
Dec 31, 2025
Merged

feat: refine English wording for docs files: 43-50#421
hsluoyz merged 4 commits intomasterfrom
copilot/polish-docs-for-clarity

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Dec 30, 2025

fix: #420

@netlify
Copy link
Copy Markdown

netlify bot commented Dec 30, 2025

Deploy Preview for casbin ready!

Name Link
🔨 Latest commit 0518da6
🔍 Latest deploy log https://app.netlify.com/projects/casbin/deploys/6954953d7f224000082dc642
😎 Deploy Preview https://deploy-preview-421--casbin.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@CLAassistant
Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Co-authored-by: tjyyy3 <97741063+tjyyy3@users.noreply.github.com>
Copilot AI changed the title [WIP] Polish selected documentation for clarity and readability Polish documentation for clarity and readability Dec 30, 2025
Copilot AI requested a review from tjyyy3 December 30, 2025 14:53
@hsluoyz hsluoyz marked this pull request as ready for review December 30, 2025 18:07
@tjyyy3
Copy link
Copy Markdown
Contributor

tjyyy3 commented Dec 31, 2025

@copilot
Please fully rewrite these documentation, not light editing or polishing.
The goal is to make the documentation read as if it were written by a native English-speaking developer, for a global developer audience.

Requirements:

  • Rewrite the document completely, rephrasing every sentence.
  • Preserve the original meaning, intent, and technical correctness.
  • Do NOT add, remove, or reinterpret technical content.
  • Do NOT introduce new features, behaviors, or examples.
  • Structural and wording changes are allowed if they improve readability and logical flow.
  • Paragraph lengths may change as needed for clarity.
  • Write in natural, idiomatic, professional English.
  • Avoid marketing language, exaggerated claims, or generic AI-style phrasing.
  • Avoid unnecessary verbosity; prefer clear and direct explanations.
  • Do NOT convert narrative explanations into bullet lists unless the original content already uses lists.

Output expectation:
Produce a rewritten version that conveys exactly the same information, but is clearer, smoother, and more natural to read.

Co-authored-by: tjyyy3 <97741063+tjyyy3@users.noreply.github.com>
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Dec 31, 2025

@copilot
Please fully rewrite these documentation, not light editing or polishing.
The goal is to make the documentation read as if it were written by a native English-speaking developer, for a...

Complete rewrite finished. All 8 documentation files have been fully rephrased with natural, idiomatic English while preserving technical accuracy and meaning. Every sentence was rewritten to sound like it was written by a native English speaker.

Changes implemented in commit 3a8080d:

  • Overview.mdx: Completely rephrased all sections
  • GetStarted.mdx: Rewrote setup and usage instructions
  • HowItWorks.mdx: Restructured PERM model explanation
  • Tutorial.mdx: Improved introduction phrasing
  • SupportedModels.mdx: Rewrote all 18 model descriptions
  • SyntaxForModels.mdx: Rephrased syntax definitions and examples
  • Effector.mdx: Improved function descriptions
  • Function.mdx: Restructured built-in and custom function guidance

All markdown linting passed. Technical content, examples, and code remain unchanged.

Co-authored-by: tjyyy3 <97741063+tjyyy3@users.noreply.github.com>
Copilot AI changed the title Polish documentation for clarity and readability Completely rewrite documentation for natural English flow Dec 31, 2025
@hsluoyz hsluoyz changed the title Completely rewrite documentation for natural English flow feat: refine English wording for docs files: 43-50 Dec 31, 2025
@hsluoyz hsluoyz merged commit e3b8b84 into master Dec 31, 2025
7 of 9 checks passed
@hsluoyz hsluoyz deleted the copilot/polish-docs-for-clarity branch March 22, 2026 02:31
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.

[docs] fully rewrite 43-50 docs

4 participants