Skip to content

docs: Update README.md with corrected links to documentation#2551

Open
ppival wants to merge 4 commits intokoala73:mainfrom
ppival:README.md
Open

docs: Update README.md with corrected links to documentation#2551
ppival wants to merge 4 commits intokoala73:mainfrom
ppival:README.md

Conversation

@ppival
Copy link
Copy Markdown

@ppival ppival commented Mar 30, 2026

Summary

update links to documentation in README.md

Type of change

  • Bug fix
  • New feature
  • New data source / feed
  • New map layer
  • Refactor / code cleanup
  • Documentation
  • CI / Build / Infrastructure

Affected areas

  • Map / Globe
  • News panels / RSS feeds
  • AI Insights / World Brief
  • Market Radar / Crypto
  • Desktop app (Tauri)
  • API endpoints (/api/*)
  • Config / Settings
  • Other: Documentation

Checklist

  • Tested on worldmonitor.app variant
  • Tested on tech.worldmonitor.app variant (if applicable)
  • New RSS feed domains added to api/rss-proxy.js allowlist (if adding feeds)
  • No API keys or secrets committed
  • TypeScript compiles without errors (npm run typecheck)

Screenshots

@vercel
Copy link
Copy Markdown

vercel bot commented Mar 30, 2026

@ppival is attempting to deploy a commit to the Elie Team on Vercel.

A member of the Team first needs to authorize it.

@github-actions github-actions bot added the trust:caution Brin: contributor trust score caution label Mar 30, 2026
@greptile-apps
Copy link
Copy Markdown

greptile-apps bot commented Mar 30, 2026

Greptile Summary

This PR migrates all documentation links in README.md from the old docs.worldmonitor.app subdomain to paths under www.worldmonitor.app/docs/, reflecting a change in how the Mintlify docs site is hosted (now proxied through Vercel at /docs rather than a dedicated subdomain). The migration is mostly correct, but one link destination is wrong.

  • All links from https://docs.worldmonitor.app/* are updated to https://www.worldmonitor.app/docs/* — the new base is consistent with docs.json and AGENTS.md ("Docs: Mintlify (proxied through Vercel at /docs)").
  • The "architecture docs" link target is wrong: it was changed to /docs/getting-started#map-rendering-architecture, but a dedicated docs/architecture.mdx page exists and is registered in docs/docs.json navigation. The correct URL should be https://www.worldmonitor.app/docs/architecture.
  • The footer link text was also changed from the short docs.worldmonitor.app to the full path www.worldmonitor.app/docs/documentation, which is inconsistent with the other clean subdomain-style display names used nearby.

Confidence Score: 4/5

Safe to merge after fixing the architecture docs link, which points to the wrong page.

One P1 finding: the "architecture docs" link resolves to /docs/getting-started#map-rendering-architecture rather than the dedicated /docs/architecture page that exists in the repository. This is a documentation-only PR, so there is no code risk, but the broken link would actively misdirect users looking for the full architecture reference.

README.md — specifically line 89 (architecture docs link) and line 155 (footer link text).

Important Files Changed

Filename Overview
README.md Updates 6 documentation links from the old docs.worldmonitor.app subdomain to www.worldmonitor.app/docs/*, but the "architecture docs" link incorrectly targets /docs/getting-started#map-rendering-architecture instead of the dedicated /docs/architecture page.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[README.md link] -->|old| B["docs.worldmonitor.app/*"]
    A -->|new| C["www.worldmonitor.app/docs/*"]
    C --> D["/docs/documentation ✅"]
    C --> E["/docs/contributing ✅"]
    C --> F["/docs/getting-started ✅"]
    C --> G["/docs/getting-started#map-rendering-architecture ⚠️"]
    C --> H["/docs/data-sources ✅"]
    G -->|should be| I["/docs/architecture ✅"]
    style G fill:#f9a,stroke:#f33
    style I fill:#afa,stroke:#3a3
Loading

Reviews (1): Last reviewed commit: "Update README.md with corrected links to..." | Re-trigger Greptile

@SebastienMelki
Copy link
Copy Markdown
Collaborator

@ppival — thanks! Two small corrections before merging:

  1. Architecture link: Line 89 links to /docs/getting-started#map-rendering-architecture but there's a dedicated /docs/architecture page. Change to https://www.worldmonitor.app/docs/architecture
  2. Footer link display text: Changed to the verbose www.worldmonitor.app/docs/documentation — should remain shorter, like "WorldMonitor Docs" or just the URL without /documentation

Once updated, ready to merge.

ppival and others added 2 commits April 1, 2026 14:32
Update link to architecture page

Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Not technically accurate, IMHO, but prettier.

Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Copy link
Copy Markdown
Author

@ppival ppival left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As per suggestions

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

trust:caution Brin: contributor trust score caution

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants