-
-
Notifications
You must be signed in to change notification settings - Fork 380
Closed as not planned
Closed as not planned
Copy link
Description
📄 Documentation Cleanup: Fix Outdated Links, HTTP URLs & Formatting Issues
📝 Summary
Several documentation files contain outdated GitHub URLs, insecure HTTP links, and small formatting mistakes. Updating these will improve accuracy, security, and overall documentation quality.
🔎 Issues Identified
1. Outdated GitHub URLs using master instead of main
Files affected:
RELEASE_PROCESS.mdspec/asyncapi.md(multiple binding URLs)
Problem:
GitHub has migrated default branches to main, but many links still point to /master/, causing redirects or potential 404s.
Examples:
RELEASE_PROCESS.md— Line 26
https://github.com/asyncapi/parser-js/blob/master/CODEOWNERSspec/asyncapi.md— Lines 1125–1143
URLs like:
https://github.com/asyncapi/bindings/blob/master/http#server
Proposed Fix: Replace all /master/ URLs with /main/.
2. HTTP link should be HTTPS
File: spec/asyncapi.md
Line: 843
- Current:
http://spec.commonmark.org/ - Should be:
https://spec.commonmark.org/
Reason: HTTPS improves security and ensures modern compatibility.
3. Minor formatting & grammar issues
README.md
- Line 19:
</br>→<br>
examples/README.md
- Duplicate word: “the the name” → “the name”
📌 Why This Matters
- Prevents broken/redirected links
- Improves documentation security (HTTPS)
- Ensures readability and consistency
- Keeps project aligned with GitHub’s current branch standards
✔ Proposed Solution
I would like to open a PR that:
- Updates all outdated
/master/URLs to/main/ - Converts the HTTP link to HTTPS
- Fixes minor formatting and grammar errors
Please let me know if @derberg (maintainers) approve. I’m happy to create the PR.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels