-
Notifications
You must be signed in to change notification settings - Fork 974
fix(README): Resolve markdownlint issues #469
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
hvert
commented
Aug 16, 2025
- Add language identifiers to fenced code blocks (MD040)
- Format bare URLs as proper markdown links (MD034)
- Add language identifiers to fenced code blocks (MD040) - Format bare URLs as proper markdown links (MD034)
@hvert is attempting to deploy a commit to the Vercel Labs Team on Vercel. A member of the Team first needs to authorize it. |
5. Access the application: | ||
- Main site: http://localhost:3000 | ||
- Admin panel: http://localhost:3000/admin | ||
- Main site: <http://localhost:3000> |
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.
Inconsistent URL formatting where two URLs use markdown link format but the third remains in plain text.
View Details
📝 Patch Details
diff --git a/README.md b/README.md
index 178364c..ca39f97 100644
--- a/README.md
+++ b/README.md
@@ -61,7 +61,7 @@ A production-ready example of a multi-tenant application built with Next.js 15,
5. Access the application:
- Main site: <http://localhost:3000>
- Admin panel: <http://localhost:3000/admin>
- - Tenants: http://[tenant-name].localhost:3000
+ - Tenants: <http://[tenant-name].localhost:3000>
## Multi-Tenant Architecture
Analysis
The URLs in the "Access the application" section have inconsistent formatting. Lines 62-63 use markdown angle bracket format (<http://...>
), while line 64 uses plain text format (http://...
). This inconsistency makes the documentation appear unpolished and may confuse readers about which URLs are clickable links.
In markdown viewers, the angle bracket format creates clickable links, while plain text URLs may not be automatically converted to links depending on the viewer.
Recommendation
Make all URLs consistent by either:
- Using angle brackets for all URLs:
- Main site: <http://localhost:3000>
- Admin panel: <http://localhost:3000/admin>
- Tenants: <http://[tenant-name].localhost:3000>
- Or using plain text for all URLs:
- Main site: http://localhost:3000
- Admin panel: http://localhost:3000/admin
- Tenants: http://[tenant-name].localhost:3000
The angle bracket format is recommended as it ensures the URLs are clickable links in markdown viewers.
README.md
Outdated
Create a `.env.local` file in the root directory with: | ||
|
||
``` | ||
```javascript |
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.
```javascript | |
```bash |
The code block for environment variables is incorrectly labeled as javascript
when it should be a plain text or .env
format.
View Details
Analysis
The environment variables code block is marked with javascript
syntax highlighting, but .env.local
files use a simple KEY=value
format, not JavaScript syntax. This incorrect labeling could confuse developers about the proper format for environment variables and may cause syntax highlighting to display incorrectly in documentation viewers.
Environment variable files use a plain text format where each line contains a key-value pair separated by an equals sign, without quotes, semicolons, or other JavaScript syntax elements.
Recommendation
Change the code block language from javascript
to either no language specifier (empty) or use bash
, .env
, or dotenv
for more appropriate syntax highlighting. For example:
```bash
KV_REST_API_URL=your_redis_url
KV_REST_API_TOKEN=your_redis_token
or simply:
KV_REST_API_URL=your_redis_url
KV_REST_API_TOKEN=your_redis_token
</details>
<!-- VADE-RECOMMENDATION: SUGGESTION -->
<!-- VADE-GITHUB-REVIEW-BOT-ACTIVE -->
<!-- VADE-GITHUB-REVIEW-BOT-SHA:85a771a7aeceb937a22386e5dd79fb4a09b5ee43 -->
<!-- VADE-GITHUB-REVIEW-BOT-BASE-SHA:29cfcbe47d7696d7bf65801f944e4345712f8dd8 -->
- Consistently format all localhost URLs with angle brackets (<http://...>) to ensure clickable links and match markdown best practices - Change code block language from `javascript` to `bash` for .env variables to reflect the correct syntax highlighting Addresses Vercel bot recommendations for: - Inconsistent URL formatting (lines 61-64) - Incorrect language specifier for env variables (line 47)
@hvert ✅ Consistent URL formatting Now using angle brackets (http://...) for all localhost URLs to ensure clickable links ✅ Corrected code block syntax Updated .env example from javascript to bash for proper syntax highlighting These changes follow markdown best practices and improve readability. Let me know if any other adjustments are needed! |