-
Notifications
You must be signed in to change notification settings - Fork 3
docs: blog: draft new website post #143
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
WalkthroughA new blog post is added at Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 3
🧹 Nitpick comments (1)
blog/2025-11-19-a-shiny-new-website.md (1)
6-6: Consider stronger wording in the introduction.The phrase "opportunities for further improvements" is somewhat generic. Consider more concrete or specific language to strengthen the opening.
For example: "and a platform for continued innovation" or "laying the groundwork for ambitious features ahead."
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
blog/assets/a-shiny-new-website/draftail-design-2018.pngis excluded by!**/*.png
📒 Files selected for processing (1)
blog/2025-11-19-a-shiny-new-website.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
blog/2025-11-19-a-shiny-new-website.md
[style] ~6-~6: Consider an alternative to strengthen your wording.
Context: ...y new features ✨, and opportunities for further improvements. This site’s design...
(IMPROVEMENTS_REFINEMENTS)
🪛 markdownlint-cli2 (0.18.1)
blog/2025-11-19-a-shiny-new-website.md
37-37: Bare URL used
(MD034, no-bare-urls)
39-39: Bare URL used
(MD034, no-bare-urls)
49-49: Bare URL used
(MD034, no-bare-urls)
51-51: Bare URL used
(MD034, no-bare-urls)
53-53: Bare URL used
(MD034, no-bare-urls)
55-55: Bare URL used
(MD034, no-bare-urls)
56-56: Bare URL used
(MD034, no-bare-urls)
| I briefly considered alternatives like [VitePress](https://vitepress.dev/) and [Starlight](https://starlight.astro.build/). They’re nice and shiny, seem to provide similar ergonomics, but not be opinionated enough. It would require plugins and custom development to get the features I’m after: | ||
|
|
||
| - Blogging. Certainly something I don’t want to reinvent. | ||
| - |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Complete the empty bullet point.
Line 29 contains a bare - with no following content, indicating incomplete markup.
Apply this fix to remove the incomplete bullet:
- Blogging. Certainly something I don't want to reinvent.
-Committable suggestion skipped: line range outside the PR's diff.
🤖 Prompt for AI Agents
In blog/2025-11-19-a-shiny-new-website.md around line 29 there is a bare list
marker "-" with no content; remove the empty bullet or replace it with the
intended list item text so the markdown list is complete and no blank list
element remains.
| ## Future features | ||
|
|
||
| [llms.txt](https://llmstxt.org/) | ||
|
|
||
| [Ask AI](https://docsearch.algolia.com/docs/v4/askai/) with [OpenRouter](https://openrouter.ai/) | ||
|
|
||
| SEO https://docusaurus.io/docs/seo | ||
|
|
||
| https://docsearch.algolia.com/ issues indexing | ||
|
|
||
| [NLWeb](https://github.com/nlweb-ai/NLWeb) | ||
|
|
||
| [HUD in Netlify](https://docs.netlify.com/deploy/review-deploys/heads-up-display/) | ||
|
|
||
| Dark theme | ||
|
|
||
| Multilingual content | ||
|
|
||
| https://pagespeed.web.dev/analysis/https-www-draftail-org-docs-api/rfwgitxncz?form_factor=mobile | ||
|
|
||
| https://pagespeed.web.dev/analysis/https-69172eea3b977200082d7b3b--draftail-netlify-app-docs-api/27t1cexryr?form_factor=mobile | ||
|
|
||
| https://69172eea3b977200082d7b3b--draftail.netlify.app/docs/api | ||
|
|
||
| https://angular.dev/ai | ||
| https://docs.modular.com/max/coding-assistants/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Complete and structure the "Future features" section before publishing.
This section reads like incomplete draft notes rather than finalized blog content. It contains bare URLs, fragmentary descriptions, and lacks coherent structure. Each future feature should be properly described with context.
Suggestions:
- Either expand each item with a brief description explaining the feature, why it's planned, and its expected impact
- Or move this section to an internal notes/roadmap document and remove it from the published blog post if the features aren't ready to be publicly discussed yet
For now, at minimum:
- Replace bare URLs with proper markdown links (e.g.,
[llms.txt](https://llmstxt.org/)) - Complete the empty bullet point at line 29
- Add substantive descriptions or context for each feature
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
37-37: Bare URL used
(MD034, no-bare-urls)
39-39: Bare URL used
(MD034, no-bare-urls)
49-49: Bare URL used
(MD034, no-bare-urls)
51-51: Bare URL used
(MD034, no-bare-urls)
53-53: Bare URL used
(MD034, no-bare-urls)
55-55: Bare URL used
(MD034, no-bare-urls)
56-56: Bare URL used
(MD034, no-bare-urls)
|
|
||
| [Ask AI](https://docsearch.algolia.com/docs/v4/askai/) with [OpenRouter](https://openrouter.ai/) | ||
|
|
||
| SEO https://docusaurus.io/docs/seo |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wrap bare URLs in markdown link syntax.
Multiple URLs violate markdownlint rule MD034 and should be wrapped in proper markdown link format. This improves readability and makes links clickable in markdown viewers.
Examples:
-SEO https://docusaurus.io/docs/seo
+[SEO](https://docusaurus.io/docs/seo)
-https://docsearch.algolia.com/ issues indexing
+[Algolia DocSearch indexing issues](https://docsearch.algolia.com/)
-https://pagespeed.web.dev/analysis/https-www-draftail-org-docs-api/rfwgitxncz?form_factor=mobile
+[PageSpeed Insights - mobile analysis](https://pagespeed.web.dev/analysis/https-www-draftail-org-docs-api/rfwgitxncz?form_factor=mobile)Apply similar formatting to all other bare URLs in this section (lines 39, 49, 51, 53, 55, 56).
Also applies to: 39-39, 49-49, 51-51, 53-53, 55-55, 56-56
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
37-37: Bare URL used
(MD034, no-bare-urls)
🤖 Prompt for AI Agents
In blog/2025-11-19-a-shiny-new-website.md around line 37 (also apply to lines
39, 49, 51, 53, 55, 56), there are bare URLs (e.g.,
"https://docusaurus.io/docs/seo") that violate markdownlint MD034; update each
bare URL to use markdown link syntax like [link text](https://example.com) or
inline descriptive text in brackets followed by the URL in parentheses, ensuring
descriptive link text where appropriate and leaving no bare URLs in those lines.
✨
Summary by CodeRabbit