docs: add a first blog post in the website#672
Conversation
This first blog post is an overview about what's been accomplished in 2024 and what to expect next in 2025. A simple Docusaurus blog configuration has been initialized: - global authors - blog edit link Additional website changes - Fix regular docs page edit url: use an edit link, not a view link - Change the order of items in navbar and in the footer after the introduction of the Blog
WalkthroughThis pull request introduces a new blog post titled "Looking Ahead: maxGraph in 2025," outlining the future direction and goals for the maxGraph library, including documentation improvements and tree-shaking optimizations. An author entry for Thomas Bouffard has been added to the blog configuration. The Docusaurus configuration has been updated to include a new constant for the edit URL and reorganized navigation and footer links for improved clarity and accessibility. Changes
Possibly related PRs
Suggested labels
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
packages/website/docusaurus.config.ts (1)
48-50: Consider additional blog configuration options.While the current configuration is sufficient, you might want to consider these additional options for better blog functionality:
showReadingTime: true- Shows estimated reading timepostsPerPage: 5- Controls paginationblogSidebarCount: 'ALL'- Shows all posts in sidebarpackages/website/blog/2025/02-12-looking-ahead-maxgraph-in-2025.md (1)
43-43: Consider these grammar improvements.
- Add a comma before "and" in compound sentences:
-In the initial release, Internet Explorer support was removed and custom code was replaced with modern ECMAScript APIs. +In the initial release, Internet Explorer support was removed, and custom code was replaced with modern ECMAScript APIs.
Avoid repetitive sentence beginnings around line 49.
Add a comma in:
-Issues will continue to be addressed and performance improvements will be made. +Issues will continue to be addressed, and performance improvements will be made.Also applies to: 49-49, 68-68
🧰 Tools
🪛 LanguageTool
[uncategorized] ~43-~43: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...e, Internet Explorer support was removed and custom code was replaced with modern EC...(COMMA_COMPOUND_SENTENCE_2)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
packages/website/blog/2025/02-12-looking-ahead-maxgraph-in-2025.md(1 hunks)packages/website/blog/authors.yml(1 hunks)packages/website/docusaurus.config.ts(4 hunks)
🧰 Additional context used
🪛 LanguageTool
packages/website/blog/2025/02-12-looking-ahead-maxgraph-in-2025.md
[uncategorized] ~43-~43: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...e, Internet Explorer support was removed and custom code was replaced with modern EC...
(COMMA_COMPOUND_SENTENCE_2)
[style] ~49-~49: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ctly, avoiding transitive inclusion. - [v0.12.0](https://github.com/maxGraph/maxGr...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~68-~68: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...ty. Issues will continue to be addressed and performance improvements will be made. ...
(COMMA_COMPOUND_SENTENCE_2)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: build
🔇 Additional comments (6)
packages/website/docusaurus.config.ts (3)
6-6: LGTM! Good refactoring.Extracting the GitHub edit URL into a constant improves maintainability and reduces duplication.
84-107: LGTM! Navigation structure is well-organized.The navigation items are logically ordered and the labels are concise. The changes align well with the PR objectives.
126-133: LGTM! Footer links are consistent with navigation.The footer links maintain consistency with the navigation structure, using clear and descriptive labels.
packages/website/blog/authors.yml (1)
1-7: LGTM! Author entry is well-structured.The author entry contains all necessary information and follows YAML best practices.
packages/website/blog/2025/02-12-looking-ahead-maxgraph-in-2025.md (2)
1-6: LGTM! Frontmatter is complete and well-structured.The frontmatter contains all necessary fields with clear and informative content.
13-13: LGTM! Truncate marker is correctly placed.The truncate marker is well-positioned to create an engaging blog preview.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
packages/website/blog/2025/02-12-looking-ahead-maxgraph-in-2025.md (2)
47-49: Consider varying sentence beginnings.To improve readability, consider rewording the version entries to avoid repetitive beginnings:
-- [v0.6.0](https://github.com/maxGraph/maxGraph/releases/tag/v0.6.0): Codecs are no longer registered by default. -- [v0.11.0](https://github.com/maxGraph/maxGraph/releases/tag/v0.11.0): `MaxLog` and `MaxWindow` are no longer called directly, avoiding transitive inclusion. -- [v0.12.0](https://github.com/maxGraph/maxGraph/releases/tag/v0.12.0): The npm package is declared without side effects. +- Release [v0.6.0](https://github.com/maxGraph/maxGraph/releases/tag/v0.6.0): Codecs are no longer registered by default. +- In [v0.11.0](https://github.com/maxGraph/maxGraph/releases/tag/v0.11.0): `MaxLog` and `MaxWindow` are no longer called directly, avoiding transitive inclusion. +- With [v0.12.0](https://github.com/maxGraph/maxGraph/releases/tag/v0.12.0): The npm package is declared without side effects.🧰 Tools
🪛 LanguageTool
[style] ~49-~49: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ctly, avoiding transitive inclusion. - [v0.12.0](https://github.com/maxGraph/maxGr...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
81-81: Fix emphasis formatting in P.S. section.The emphasis formatting has extra asterisks.
-*P.S. We're looking for contributors and maintainers to keep the project alive and kicking. Check out ****[Issue #354](https://github.com/maxGraph/maxGraph/issues/354)**** if you're interested! 😄* +*P.S. We're looking for contributors and maintainers to keep the project alive and kicking. Check out **[Issue #354](https://github.com/maxGraph/maxGraph/issues/354)** if you're interested! 😄*
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
packages/website/blog/2025/02-12-looking-ahead-maxgraph-in-2025.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
packages/website/blog/2025/02-12-looking-ahead-maxgraph-in-2025.md
[style] ~49-~49: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ctly, avoiding transitive inclusion. - [v0.12.0](https://github.com/maxGraph/maxGr...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🔇 Additional comments (4)
packages/website/blog/2025/02-12-looking-ahead-maxgraph-in-2025.md (4)
8-15: Well-structured introduction!The introduction effectively sets the context and uses the truncate marker appropriately.
16-33: Well-organized documentation section!The section effectively communicates achievements and future plans, with proper GitHub issue referencing.
62-73: Clear and concise additional topics!The sections on stabilization and API definition effectively communicate the plans.
4-4: Verify author reference in authors.yml.Please ensure that the author reference "tbouffard" exists in the
authors.ymlconfiguration file.✅ Verification successful
🏁 Script executed:
#!/bin/bash # Description: Check if the author exists in authors.yml rg -A 5 "tbouffard:" packages/website/blog/authors.ymlLength of output: 211
Author reference verified in authors.yml.
The configuration file confirms that the author "tbouffard" is correctly specified.
|
This first blog post is an overview about what's been accomplished in 2024 and what to expect next in 2025.
A simple Docusaurus blog configuration has been initialized:
Additional website changes
Summary by CodeRabbit
New Features
Documentation & Navigation Updates