Skip to content

docs: polish en version#187

Merged
roife merged 3 commits into
masterfrom
docs/polish-english-docs
May 28, 2026
Merged

docs: polish en version#187
roife merged 3 commits into
masterfrom
docs/polish-english-docs

Conversation

@roife
Copy link
Copy Markdown
Member

@roife roife commented May 28, 2026

No description provided.

Copilot AI review requested due to automatic review settings May 28, 2026 13:02
@github-actions
Copy link
Copy Markdown

Docs preview: https://vide.pascal-lab.net/preview/pr-187/

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR polishes English documentation copy across the homepage data, English user guide and feature pages, and a few Chinese pages, and adds a localized English 404 page. Wording is tightened (e.g., "best-effort workspace index", "code exploration", "Go to Definition"), feature names are consistently capitalized, and a few small Chinese typo/terminology fixes are made.

Changes:

  • Refines English feature descriptions and homepage copy for clarity and consistent capitalization of feature names.
  • Updates terminology to "best-effort workspace index" / "code exploration", changes comparison meta to a uniform 'PASCAL', and rewords auto-expansion in the comparison table.
  • Adds an English 404.md mirroring the Chinese 404 page, and fixes minor Chinese copy (项目项目项目, description terminology).

Reviewed changes

Copilot reviewed 26 out of 26 changed files in this pull request and generated no comments.

Show a summary per file
File Description
docs/src/data/homepage.ts Polishes English feature descriptions; renames autoexpand to auto-expansion; sets comparison meta to 'PASCAL' for both locales.
docs/src/content/docs/index.mdx Updates Chinese homepage description terminology.
docs/src/content/docs/user-guide/index.mdx Updates Chinese intro terminology.
docs/src/content/docs/user-guide/online-experience.mdx Fixes Chinese duplicated 项目项目 typo.
docs/src/content/docs/en/index.mdx Reworks English hero title/tagline to "A Modern SystemVerilog IDE".
docs/src/content/docs/en/404.md Adds localized English 404 splash page.
docs/src/content/docs/en/user-guide/index.mdx Rewrites the user-guide landing copy and card descriptions.
docs/src/content/docs/en/user-guide/first-project.mdx Minor wording polish ("actual paths", "argument generation", etc.).
docs/src/content/docs/en/user-guide/online-experience.mdx Quotes frontmatter description; polishes prose and capitalizes feature names.
docs/src/content/docs/en/user-guide/project-configuration.mdx Rewords description and table cells; capitalizes feature names.
docs/src/content/docs/en/user-guide/features/index.mdx Updates feature index description and card text.
docs/src/content/docs/en/user-guide/features/*.mdx Various small wording refinements across feature pages (navigation, references, rename, hover, completion, annotations, quick-fixes, diagnostics, document-symbols, folding, semantic/syntax highlighting, selection-range, signature-help).
docs/src/content/docs/en/advanced-guide/parsing-and-analysis.md Aligns terminology with "best-effort workspace index" and "code exploration".

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@roife roife force-pushed the docs/polish-english-docs branch from 7ae9420 to 1f3126c Compare May 28, 2026 13:24
@roife roife merged commit a63d5ef into master May 28, 2026
9 checks passed
@roife roife deleted the docs/polish-english-docs branch May 28, 2026 13: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.

2 participants