docs: polish en version#187
Merged
Merged
Conversation
|
Docs preview: https://vide.pascal-lab.net/preview/pr-187/ |
Contributor
There was a problem hiding this comment.
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 rewordsauto-expansionin the comparison table. - Adds an English
404.mdmirroring 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.
7ae9420 to
1f3126c
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.