Skip to content

feat: migrate documentation from docs.iex.ec/nox-protocol to docs.noxprotocol.io#66

Open
edenbd1 wants to merge 1 commit into
mainfrom
feat/migrate-to-noxprotocol-domain
Open

feat: migrate documentation from docs.iex.ec/nox-protocol to docs.noxprotocol.io#66
edenbd1 wants to merge 1 commit into
mainfrom
feat/migrate-to-noxprotocol-domain

Conversation

@edenbd1
Copy link
Copy Markdown
Contributor

@edenbd1 edenbd1 commented May 27, 2026

Summary

Separates Nox Protocol documentation onto its own domain (docs.noxprotocol.io) to prevent AI crawlers from confusing Nox with other iExec products (DataProtector, PoCo, Web3Mail, Web3Telegram) when they coexist on the same docs.iex.ec domain.

Changes

  • .vitepress/config.ts — Change base from /nox-protocol/ to /, update favicon path
  • .vitepress/theme/Layout.vue — Remove logo click handler workaround (no longer needed with base: '/')
  • src/components/AskIaButton.vue — Update ChatGPT/Claude "Ask AI" links to docs.noxprotocol.io
  • vercel.json — Remove old rewrite rule, add 301 redirects from /nox-protocol/* paths, update robots.txt host check
  • src/index.md — Strengthen LLM-only context with explicit domain separation
  • README.md / CONTRIBUTING.md — Update documentation links

Prerequisites before merging

  1. Add docs.noxprotocol.io as a custom domain in Vercel (nox-documentation project → Settings → Domains)
  2. Configure DNS CNAME record for docs.noxprotocol.iocname.vercel-dns.com
  3. Wait for DNS propagation + SSL provisioning
  4. Then merge this PR

After merging (separate repo)

  • Update the Nox Protocol card link on docs.iex.ec homepage → https://docs.noxprotocol.io/
  • Add 301 redirects on docs.iex.ec from /nox-protocol/*docs.noxprotocol.io/*

Test plan

  • Verify DNS is configured and docs.noxprotocol.io resolves
  • Check Vercel preview deployment loads correctly at root /
  • Verify favicon loads without /nox-protocol/ prefix
  • Test "Ask in ChatGPT" and "Open in Claude" buttons point to docs.noxprotocol.io URLs
  • Confirm /nox-protocol/getting-started/welcome redirects 301 to /getting-started/welcome
  • Verify all internal navigation links work
  • Check robots.txt serves correct version based on host

…protocol.io

Separate Nox Protocol docs onto its own domain to prevent AI crawlers
from confusing Nox with other iExec products (DataProtector, PoCo).

- Change VitePress base path from /nox-protocol/ to /
- Update AskIaButton ChatGPT/Claude links to docs.noxprotocol.io
- Remove Layout.vue logo click handler workaround
- Add 301 redirects from old /nox-protocol/* paths
- Update robots.txt host check to docs.noxprotocol.io
- Update LLM-only context to reference new domain
@edenbd1 edenbd1 requested review from 64ix, akugone and Copilot May 27, 2026 08:26
@vercel
Copy link
Copy Markdown

vercel Bot commented May 27, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
nox-documentation Ready Ready Preview, Comment May 27, 2026 8:28am

Request Review

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Migrates the Nox Protocol documentation site from being served under the /nox-protocol/ subpath on docs.iex.ec to a dedicated root deployment intended for docs.noxprotocol.io, including redirect and link updates to preserve old URLs and reduce cross-product confusion for crawlers/LLMs.

Changes:

  • Switch VitePress base to / and update static asset paths accordingly.
  • Update Vercel routing to 301-redirect legacy /nox-protocol/* paths and adjust robots.txt host-based behavior for the new domain.
  • Update “Ask AI” links and repo docs to reference docs.noxprotocol.io.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
vercel.json Replace rewrite with permanent redirects for legacy paths; update robots.txt host routing.
.vitepress/config.ts Set base: '/' and update favicon path for root hosting.
.vitepress/theme/Layout.vue Remove now-unneeded click handler workaround tied to the old base path.
src/components/AskIaButton.vue Point “Ask in ChatGPT/Claude” prompts at the new docs domain.
src/index.md Strengthen LLM-only context to explicitly separate domains/products.
README.md Update documentation link to the new domain.
CONTRIBUTING.md Update documentation link to the new domain.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines 173 to 181
const chatGPTLink = computed(() => {
const fullUrl = `https://docs.iex.ec${route.path}`;
const fullUrl = `https://docs.noxprotocol.io${route.path}`;
const prompt = `Please research and analyze this page: ${fullUrl} so I can ask you questions about it. Once you have read it, prompt me with any questions I have. Do not post content from the page in your response. Any of my follow up questions must reference the site I gave you.`;
return `https://chatgpt.com/?hints=search&q=${encodeURIComponent(prompt)}`;
});

const claudeLink = computed(() => {
const fullUrl = `https://docs.iex.ec${route.path}`;
const fullUrl = `https://docs.noxprotocol.io${route.path}`;
const prompt = `Please research and analyze this page: ${fullUrl} so I can ask you questions about it. Once you have read it, prompt me with any questions I have. Do not post content from the page in your response. Any of my follow up questions must reference the site I gave you.`;
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants