feat(seo): robots.txt, sitemap.xml, llms.txt, canonical URL, JSON-LD, per-page meta titles/descriptions - #31

Merged
joaodibba merged 1 commit into
TypeComposer:mainfrom
lucas-spin:feat/seo-indexability
Jun 12, 2026
Merged

feat(seo): robots.txt, sitemap.xml, llms.txt, canonical URL, JSON-LD, per-page meta titles/descriptions#31
joaodibba merged 1 commit into
TypeComposer:mainfrom
lucas-spin:feat/seo-indexability

Conversation

@lucas-spin

Copy link
Copy Markdown
Contributor

What changed and why

SEO/indexability improvements based on Gonçalo's audit, as requested by João. Highest-value static wins with no new npm dependencies, no unrelated churn, and no conflict with #30 (already merged).


Architecture findings (pre-PR)

ConcernFinding
Routing modehistory: "hash" — all docs URLs are #/docs/…
Hosting fallbackpublic/.htaccess already rewrites all paths → index.html
Static file servingVite copies public/ verbatim to dist/
Existing metadataindex.html had generic OG/Twitter tags but no canonical, no JSON-LD, no robots.txt, no sitemap, no per-page titles
PR #30Merged before this PR — docs/skills route is live ✓
Hash URL + canonicalsHash fragments are not real URLs → single canonical at root is correct; per-page canonicals add no benefit without SSR
Clean URL migrationDeferred — server must be verified to support try_files / Apache rewrite for every /docs/* path; .htaccess is present but hosting needs confirmation

Changes

FileWhat
public/robots.txtAllow all crawlers; Sitemap: directive pointing to sitemap
public/sitemap.xml29 <url> entries for every registered route (home, all docs pages, playground)
public/llms.txtllmstxt.org convention — machine-readable site manifest for LLM indexers (GPTBot, Claude, Gemini)
index.html<link rel="canonical"> → root URL; two JSON-LD blocks (WebSite + SoftwareApplication); improved title/description copy ("zero-HTML" framing)
src/utils/seo.tsNewupdatePageMeta(pathname) with per-route <title> + <meta name="description"> map (29 routes)
src/views/elements/Base.tsCall updatePageMeta(Router.pathname) in BaseView constructor — fires on every docs page navigation

What was deferred / not included

ItemReason
Clean (history-mode) URLsRequires confirming hosting supports path rewrites for all/docs/* URLs before enabling history: "browser" in the router — wrong call without server verification; the .htaccess is present but needs testing
Per-page canonical URLsNo benefit over root canonical with hash routing + no SSR
Prerendering / static HTMLOut of scope — would require either SSR or a prerender plugin

Validation

npm install
npm run build # ✓ built in 11.11s — zero errors, zero new warnings

Build confirms all 3 static files are copied to dist/ (robots.txt, sitemap.xml, llms.txt), index.html contains canonical and JSON-LD, and seo.ts is tree-shaken cleanly into the bundle.

Diff: 6 files — 430 insertions, 9 deletions (index.html copy improvements).

Reviewer

@zico15

… per-page meta
P0/P1 indexability improvements based on Gonçalo's audit:
- public/robots.txt — allow all crawlers, point to sitemap
- public/sitemap.xml — 29 URL entries covering all docs routes + home + playground
- public/llms.txt — LLM-friendly site manifest (llmstxt.org convention)
- index.html — canonical <link> pointing to https://typecomposer.com/;
two JSON-LD blocks (WebSite + SoftwareApplication);
improved global title/description ('zero-HTML' framing)
- src/utils/seo.ts — updatePageMeta() utility: per-route <title> and
<meta name=description> map (29 routes); called on each
route activation so browser history and JS-rendered tabs
show meaningful page titles
- src/views/elements/Base.ts — call updatePageMeta(Router.pathname) in BaseView
constructor so every docs page updates the document title
Hash routing constraint: canonical stays fixed at the root URL since hash
fragments are not real URLs (no per-page canonical benefit without SSR).
Clean URL migration deferred — requires hosting config validation.
Build: vite build ✓ 11.11s, 0 errors
Resolves: robots.txt missing, no sitemap, no per-page titles/descriptions
@joaodibba
joaodibba merged commit f104878 into TypeComposer:mainJun 12, 2026
1 check failed
joaodibba pushed a commit that referenced this pull request Jun 12, 2026
… URLs
SEO P0 follow-up to PRs #29#31.
Problem: hash routing (/#/docs/skills) is not indexable by search engines
because the fragment is never sent to the server. Direct deep-links also 404
without a server-side SPA fallback.
Changes:
- src/router/router.ts: history: "hash" → history: "browser" — enables clean
URLs like /docs/skills, /docs/getting-started, /playground
- vite.config.js: base: "./" → base: "/" — absolute asset paths prevent
broken asset loads when navigating to nested routes (e.g. /docs/skills)
- public/.htaccess: improve comments; SPA fallback rule was already correct
(rewrite all non-file/non-dir requests to /index.html) and remains unchanged
in logic — confirmed present before this PR
- src/utils/seo.ts: add per-route canonical <link> injection (setCanonical);
now meaningful because each route has a real URL; updated Router description
to remove "hash" reference; root canonical in index.html stays https://typecomposer.com/
- public/sitemap.xml: strip /#/ from all 29 URLs (e.g. /#/docs/skills →
/docs/skills, /#/playground → /playground)
- public/llms.txt: strip /#/ from all 29 doc links; update Router key concept
description to reference browser history mode
- index.html: update JSON-LD SearchAction target from /#/docs/… to /docs/…
Hosting note (⚠ must verify after deploy):
The .htaccess SPA fallback was already present in the repo (added before PR #31)
and is confirmed to contain the correct RewriteRule. Direct deep-link indexability
(e.g. https://typecomposer.com/docs/skills returning 200 not 404) requires the
Apache server to honour this .htaccess. Test with:
curl -I https://typecomposer.com/docs/skills
Expected: HTTP/2 200, not 301/302/404.
Build: npm run build — ✓ 2405 modules, no errors
Reviewer: @zico15
joaodibba added a commit that referenced this pull request Jun 12, 2026
…e URLs (#32)
## SEO P0 — Clean URLs via Browser History Routing
Follow-up to #29, #30, #31.
### Problem
Hash routing (`/#/docs/skills`) is not indexable by search engines — the
fragment after `#` is never sent to the server, so Googlebot sees only
`https://typecomposer.com/` for every page. Direct deep-links to
`/docs/skills` also 404 without a proper SPA fallback. This means the
sitemap, per-route canonicals, and per-page meta added in #31 cannot
deliver their full SEO value.
### Solution
Switch `Router.create` from `history: "hash"` to `history: "browser"`
(HTML5 `pushState`). The server-side SPA fallback (`.htaccess`) was
**already present in the repo** before this PR and contains the correct
`RewriteRule ^.*$ /index.html [L,QSA]` — so direct deep-links will be
served correctly on the Apache-hosted production site once this PR is
merged and deployed.
---
### Files Changed (7)
| File | Change |
|------|--------|
| `src/router/router.ts` | `history: "hash"` → `history: "browser"` |
| `vite.config.js` | `base: "./"` → `base: "/"` — absolute asset paths
prevent broken JS/CSS loads when a user navigates directly to a nested
route like `/docs/skills` (relative `./assets/` would resolve to
`/docs/assets/`) |
| `src/utils/seo.ts` | `updatePageMeta()` updates `<title>` and `<meta
name="description">` per route. Runtime `setCanonical()` workaround
**removed** — the static root canonical in `index.html` covers the home
route, and `sitemap.xml` provides authoritative clean-URL canonicals for
all 29 pages without requiring JS. |
| `public/sitemap.xml` | Strip `#/` from all 29 URLs (`/#/docs/skills` →
`/docs/skills`, `/#/playground` → `/playground`) |
| `public/llms.txt` | Same URL migration for all 29 doc links; Router
key concept updated to reference `history: "browser"` |
| `index.html` | JSON-LD `SearchAction.target` updated from
`/#/docs/{search_term_string}` → `/docs/{search_term_string}`; canonical
comment tidied |
| `public/.htaccess` | Comments improved for clarity; **rewrite rule
logic unchanged** — it was already correct |
---
### Build Validation (commit 2)
```
npm run build
✓ 2405 modules transformed — no errors, no type errors
```
```
dist/.htaccess ✓ present (copied from public/)
dist/sitemap.xml ✓ 0 hash URLs remaining
dist/llms.txt ✓ 0 hash URLs remaining
dist/index.html ✓ assets load from /assets/* (absolute paths)
dist/index.html ✓ root canonical <https://typecomposer.com/> present
src/utils/seo.ts ✓ setCanonical() removed
src/utils/seo.ts ✓ CANONICAL_BASE constant removed
```
---
### ⚠️ Hosting Verification Required Before Release
The `.htaccess` SPA fallback must be honoured by the production Apache
server. Please test after deploy:
```bash
# Direct deep-link must return HTTP 200, not 301/302/404
curl -I https://typecomposer.com/docs/skills
# Expected: HTTP/2 200
curl -I https://typecomposer.com/docs/getting-started
# Expected: HTTP/2 200
curl -I https://typecomposer.com/playground
# Expected: HTTP/2 200
# Assets must still load correctly
curl -I https://typecomposer.com/typecomposer.svg
# Expected: HTTP/2 200
curl -I https://typecomposer.com/sitemap.xml
# Expected: HTTP/2 200
```
If the Apache server requires `AllowOverride All` in its vhost config,
that must be enabled separately by the hosting admin. If `.htaccess` is
not supported, a `_redirects` (Netlify) or `vercel.json` equivalent
would be needed — but the existing `.htaccess` confirms Apache is the
target host.
---
### /docs/skills → Agent Skills ✓
Route `docs/skills` maps to `BaseView` and `PAGE_META["docs/skills"]` is
unchanged:
- Title: **Agent Skills | TypeComposer**
- Description: _Use TypeComposer to build AI agent skills…_
---
cc @zico15
zico15 added a commit that referenced this pull request Jun 12, 2026
…d-wasm and component registration (#33)
## Summary
Finishes and unblocks PR #15 (originally opened by @Copilot, which had 4
merge conflicts with `main`).
This branch is identical to the Copilot PR branch but with a merge
commit that resolves all 4 conflicts against current `main`.
---
## What this PR does
Migrates `PlaygroundView` from `@codesandbox/sandpack-client` (remote
compilation) to **fully browser-based compilation** using
`esbuild-wasm`, satisfying all acceptance criteria from issue #14.
### Changes
| File | Change |
|---|---|
| `src/utils/browserCompiler.ts` (**new**) | esbuild-wasm in-browser TS
compiler with virtual file system plugin |
| `src/components/editor/MonacoEditor.ts` (**new**) | Monaco Editor
wrapped as a TypeComposer `Component` |
| `src/views/playground/PlaygroundView.ts` | Replaced
`loadSandpackClient` with `compileAndRun()`, iframe injection via blob
URL + import map, Monaco split-view |
| `src/styles/` | Refactored `src/style.scss` → `src/styles/index.css` +
`src/styles/style.scss` (Tailwind v4) |
| `package.json` | Removed `@codesandbox/sandpack-client`; added
`esbuild-wasm ^0.25.10`, `monaco-editor ^0.54.0`, `@monaco-editor/loader
^1.5.0`, Tailwind v4 + `@tailwindcss/vite`; moved `typecomposer-plugin`
to `devDependencies`; bumped `typecomposer` to `^0.1.56` |
| `vite.config.ts` | Renamed from `.js`, added `tailwindcss()` plugin,
`base: "/"` (browser-history routing), scss preprocessor config |
### TypeComposer Component Registration
TypeComposer components (`DivElement`, `VBox`, `HBox`, etc.) are Web
Components that must be registered via `customElements.define()` before
instantiation. The playground injects an import map pointing
`typecomposer` at `esm.sh/typecomposer`, which makes the CDN-loaded
classes available to user code. `typecomposer` is marked `external` in
esbuild so imports pass through to the import map.
### Merge Conflict Resolution (vs PR #15)
The original Copilot branch diverged from `main` after `main` received
SEO/routing commits (#31, #32). This PR adds one merge commit that:
1. Bumps `typecomposer` `^0.1.54` → `^0.1.56` 2. Moves `typecomposer-plugin` to `devDependencies`
3. Fixes `vite.config.ts` `base: "./"` → `base: "/"` (required for
browser-history routing from main)
4. Adds `scss: { api: "modern-compiler" }` preprocessor config from main
5. Regenerates `package-lock.json`
---
## Build result
```
✓ 3452 modules transformed.
✓ built in 15.16s
```
---
## Acceptance criteria checklist
- [x] Remove `loadSandpackClient` and `bundlerURL` dependency
- [x] Integrate `esbuild-wasm` to compile TypeScript in the browser
- [x] Preserve `files` object / multi-file compilation
- [x] `IFrameElement` executes compiled JS via blob URL in sandboxed
iframe
- [x] Compilation and runtime errors displayed clearly
- [x] Current layout/styles maintained
- [x] TypeComposer Web Components registered before user code runs
(import map + CDN)
Closes#14
Supersedes #15 (conflict-free replacement)
cc @zico15@joaodibba
Sign up for freeto 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

@lucas-spin@joaodibba
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

feat(seo): robots.txt, sitemap.xml, llms.txt, canonical URL, JSON-LD, per-page meta titles/descriptions - #31

Merged
joaodibba merged 1 commit into
TypeComposer:mainfrom
lucas-spin:feat/seo-indexability
Jun 12, 2026
Merged

feat(seo): robots.txt, sitemap.xml, llms.txt, canonical URL, JSON-LD, per-page meta titles/descriptions#31
joaodibba merged 1 commit into
TypeComposer:mainfrom
lucas-spin:feat/seo-indexability

Conversation

@lucas-spin

Copy link
Copy Markdown
Contributor

What changed and why

SEO/indexability improvements based on Gonçalo's audit, as requested by João. Highest-value static wins with no new npm dependencies, no unrelated churn, and no conflict with #30 (already merged).


Architecture findings (pre-PR)

ConcernFinding
Routing modehistory: "hash" — all docs URLs are #/docs/…
Hosting fallbackpublic/.htaccess already rewrites all paths → index.html
Static file servingVite copies public/ verbatim to dist/
Existing metadataindex.html had generic OG/Twitter tags but no canonical, no JSON-LD, no robots.txt, no sitemap, no per-page titles
PR #30Merged before this PR — docs/skills route is live ✓
Hash URL + canonicalsHash fragments are not real URLs → single canonical at root is correct; per-page canonicals add no benefit without SSR
Clean URL migrationDeferred — server must be verified to support try_files / Apache rewrite for every /docs/* path; .htaccess is present but hosting needs confirmation

Changes

FileWhat
public/robots.txtAllow all crawlers; Sitemap: directive pointing to sitemap
public/sitemap.xml29 <url> entries for every registered route (home, all docs pages, playground)
public/llms.txtllmstxt.org convention — machine-readable site manifest for LLM indexers (GPTBot, Claude, Gemini)
index.html<link rel="canonical"> → root URL; two JSON-LD blocks (WebSite + SoftwareApplication); improved title/description copy ("zero-HTML" framing)
src/utils/seo.tsNewupdatePageMeta(pathname) with per-route <title> + <meta name="description"> map (29 routes)
src/views/elements/Base.tsCall updatePageMeta(Router.pathname) in BaseView constructor — fires on every docs page navigation

What was deferred / not included

ItemReason
Clean (history-mode) URLsRequires confirming hosting supports path rewrites for all/docs/* URLs before enabling history: "browser" in the router — wrong call without server verification; the .htaccess is present but needs testing
Per-page canonical URLsNo benefit over root canonical with hash routing + no SSR
Prerendering / static HTMLOut of scope — would require either SSR or a prerender plugin

Validation

npm install
npm run build # ✓ built in 11.11s — zero errors, zero new warnings

Build confirms all 3 static files are copied to dist/ (robots.txt, sitemap.xml, llms.txt), index.html contains canonical and JSON-LD, and seo.ts is tree-shaken cleanly into the bundle.

Diff: 6 files — 430 insertions, 9 deletions (index.html copy improvements).

Reviewer

@zico15

… per-page meta
P0/P1 indexability improvements based on Gonçalo's audit:
- public/robots.txt — allow all crawlers, point to sitemap
- public/sitemap.xml — 29 URL entries covering all docs routes + home + playground
- public/llms.txt — LLM-friendly site manifest (llmstxt.org convention)
- index.html — canonical <link> pointing to https://typecomposer.com/;
two JSON-LD blocks (WebSite + SoftwareApplication);
improved global title/description ('zero-HTML' framing)
- src/utils/seo.ts — updatePageMeta() utility: per-route <title> and
<meta name=description> map (29 routes); called on each
route activation so browser history and JS-rendered tabs
show meaningful page titles
- src/views/elements/Base.ts — call updatePageMeta(Router.pathname) in BaseView
constructor so every docs page updates the document title
Hash routing constraint: canonical stays fixed at the root URL since hash
fragments are not real URLs (no per-page canonical benefit without SSR).
Clean URL migration deferred — requires hosting config validation.
Build: vite build ✓ 11.11s, 0 errors
Resolves: robots.txt missing, no sitemap, no per-page titles/descriptions
@joaodibba
joaodibba merged commit f104878 into TypeComposer:mainJun 12, 2026
1 check failed
joaodibba pushed a commit that referenced this pull request Jun 12, 2026
… URLs
SEO P0 follow-up to PRs #29#31.
Problem: hash routing (/#/docs/skills) is not indexable by search engines
because the fragment is never sent to the server. Direct deep-links also 404
without a server-side SPA fallback.
Changes:
- src/router/router.ts: history: "hash" → history: "browser" — enables clean
URLs like /docs/skills, /docs/getting-started, /playground
- vite.config.js: base: "./" → base: "/" — absolute asset paths prevent
broken asset loads when navigating to nested routes (e.g. /docs/skills)
- public/.htaccess: improve comments; SPA fallback rule was already correct
(rewrite all non-file/non-dir requests to /index.html) and remains unchanged
in logic — confirmed present before this PR
- src/utils/seo.ts: add per-route canonical <link> injection (setCanonical);
now meaningful because each route has a real URL; updated Router description
to remove "hash" reference; root canonical in index.html stays https://typecomposer.com/
- public/sitemap.xml: strip /#/ from all 29 URLs (e.g. /#/docs/skills →
/docs/skills, /#/playground → /playground)
- public/llms.txt: strip /#/ from all 29 doc links; update Router key concept
description to reference browser history mode
- index.html: update JSON-LD SearchAction target from /#/docs/… to /docs/…
Hosting note (⚠ must verify after deploy):
The .htaccess SPA fallback was already present in the repo (added before PR #31)
and is confirmed to contain the correct RewriteRule. Direct deep-link indexability
(e.g. https://typecomposer.com/docs/skills returning 200 not 404) requires the
Apache server to honour this .htaccess. Test with:
curl -I https://typecomposer.com/docs/skills
Expected: HTTP/2 200, not 301/302/404.
Build: npm run build — ✓ 2405 modules, no errors
Reviewer: @zico15
joaodibba added a commit that referenced this pull request Jun 12, 2026
…e URLs (#32)
## SEO P0 — Clean URLs via Browser History Routing
Follow-up to #29, #30, #31.
### Problem
Hash routing (`/#/docs/skills`) is not indexable by search engines — the
fragment after `#` is never sent to the server, so Googlebot sees only
`https://typecomposer.com/` for every page. Direct deep-links to
`/docs/skills` also 404 without a proper SPA fallback. This means the
sitemap, per-route canonicals, and per-page meta added in #31 cannot
deliver their full SEO value.
### Solution
Switch `Router.create` from `history: "hash"` to `history: "browser"`
(HTML5 `pushState`). The server-side SPA fallback (`.htaccess`) was
**already present in the repo** before this PR and contains the correct
`RewriteRule ^.*$ /index.html [L,QSA]` — so direct deep-links will be
served correctly on the Apache-hosted production site once this PR is
merged and deployed.
---
### Files Changed (7)
| File | Change |
|------|--------|
| `src/router/router.ts` | `history: "hash"` → `history: "browser"` |
| `vite.config.js` | `base: "./"` → `base: "/"` — absolute asset paths
prevent broken JS/CSS loads when a user navigates directly to a nested
route like `/docs/skills` (relative `./assets/` would resolve to
`/docs/assets/`) |
| `src/utils/seo.ts` | `updatePageMeta()` updates `<title>` and `<meta
name="description">` per route. Runtime `setCanonical()` workaround
**removed** — the static root canonical in `index.html` covers the home
route, and `sitemap.xml` provides authoritative clean-URL canonicals for
all 29 pages without requiring JS. |
| `public/sitemap.xml` | Strip `#/` from all 29 URLs (`/#/docs/skills` →
`/docs/skills`, `/#/playground` → `/playground`) |
| `public/llms.txt` | Same URL migration for all 29 doc links; Router
key concept updated to reference `history: "browser"` |
| `index.html` | JSON-LD `SearchAction.target` updated from
`/#/docs/{search_term_string}` → `/docs/{search_term_string}`; canonical
comment tidied |
| `public/.htaccess` | Comments improved for clarity; **rewrite rule
logic unchanged** — it was already correct |
---
### Build Validation (commit 2)
```
npm run build
✓ 2405 modules transformed — no errors, no type errors
```
```
dist/.htaccess ✓ present (copied from public/)
dist/sitemap.xml ✓ 0 hash URLs remaining
dist/llms.txt ✓ 0 hash URLs remaining
dist/index.html ✓ assets load from /assets/* (absolute paths)
dist/index.html ✓ root canonical <https://typecomposer.com/> present
src/utils/seo.ts ✓ setCanonical() removed
src/utils/seo.ts ✓ CANONICAL_BASE constant removed
```
---
### ⚠️ Hosting Verification Required Before Release
The `.htaccess` SPA fallback must be honoured by the production Apache
server. Please test after deploy:
```bash
# Direct deep-link must return HTTP 200, not 301/302/404
curl -I https://typecomposer.com/docs/skills
# Expected: HTTP/2 200
curl -I https://typecomposer.com/docs/getting-started
# Expected: HTTP/2 200
curl -I https://typecomposer.com/playground
# Expected: HTTP/2 200
# Assets must still load correctly
curl -I https://typecomposer.com/typecomposer.svg
# Expected: HTTP/2 200
curl -I https://typecomposer.com/sitemap.xml
# Expected: HTTP/2 200
```
If the Apache server requires `AllowOverride All` in its vhost config,
that must be enabled separately by the hosting admin. If `.htaccess` is
not supported, a `_redirects` (Netlify) or `vercel.json` equivalent
would be needed — but the existing `.htaccess` confirms Apache is the
target host.
---
### /docs/skills → Agent Skills ✓
Route `docs/skills` maps to `BaseView` and `PAGE_META["docs/skills"]` is
unchanged:
- Title: **Agent Skills | TypeComposer**
- Description: _Use TypeComposer to build AI agent skills…_
---
cc @zico15
zico15 added a commit that referenced this pull request Jun 12, 2026
…d-wasm and component registration (#33)
## Summary
Finishes and unblocks PR #15 (originally opened by @Copilot, which had 4
merge conflicts with `main`).
This branch is identical to the Copilot PR branch but with a merge
commit that resolves all 4 conflicts against current `main`.
---
## What this PR does
Migrates `PlaygroundView` from `@codesandbox/sandpack-client` (remote
compilation) to **fully browser-based compilation** using
`esbuild-wasm`, satisfying all acceptance criteria from issue #14.
### Changes
| File | Change |
|---|---|
| `src/utils/browserCompiler.ts` (**new**) | esbuild-wasm in-browser TS
compiler with virtual file system plugin |
| `src/components/editor/MonacoEditor.ts` (**new**) | Monaco Editor
wrapped as a TypeComposer `Component` |
| `src/views/playground/PlaygroundView.ts` | Replaced
`loadSandpackClient` with `compileAndRun()`, iframe injection via blob
URL + import map, Monaco split-view |
| `src/styles/` | Refactored `src/style.scss` → `src/styles/index.css` +
`src/styles/style.scss` (Tailwind v4) |
| `package.json` | Removed `@codesandbox/sandpack-client`; added
`esbuild-wasm ^0.25.10`, `monaco-editor ^0.54.0`, `@monaco-editor/loader
^1.5.0`, Tailwind v4 + `@tailwindcss/vite`; moved `typecomposer-plugin`
to `devDependencies`; bumped `typecomposer` to `^0.1.56` |
| `vite.config.ts` | Renamed from `.js`, added `tailwindcss()` plugin,
`base: "/"` (browser-history routing), scss preprocessor config |
### TypeComposer Component Registration
TypeComposer components (`DivElement`, `VBox`, `HBox`, etc.) are Web
Components that must be registered via `customElements.define()` before
instantiation. The playground injects an import map pointing
`typecomposer` at `esm.sh/typecomposer`, which makes the CDN-loaded
classes available to user code. `typecomposer` is marked `external` in
esbuild so imports pass through to the import map.
### Merge Conflict Resolution (vs PR #15)
The original Copilot branch diverged from `main` after `main` received
SEO/routing commits (#31, #32). This PR adds one merge commit that:
1. Bumps `typecomposer` `^0.1.54` → `^0.1.56` 2. Moves `typecomposer-plugin` to `devDependencies`
3. Fixes `vite.config.ts` `base: "./"` → `base: "/"` (required for
browser-history routing from main)
4. Adds `scss: { api: "modern-compiler" }` preprocessor config from main
5. Regenerates `package-lock.json`
---
## Build result
```
✓ 3452 modules transformed.
✓ built in 15.16s
```
---
## Acceptance criteria checklist
- [x] Remove `loadSandpackClient` and `bundlerURL` dependency
- [x] Integrate `esbuild-wasm` to compile TypeScript in the browser
- [x] Preserve `files` object / multi-file compilation
- [x] `IFrameElement` executes compiled JS via blob URL in sandboxed
iframe
- [x] Compilation and runtime errors displayed clearly
- [x] Current layout/styles maintained
- [x] TypeComposer Web Components registered before user code runs
(import map + CDN)
Closes#14
Supersedes #15 (conflict-free replacement)
cc @zico15@joaodibba
Sign up for freeto 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

@lucas-spin@joaodibba
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(seo): robots.txt, sitemap.xml, llms.txt, canonical URL, JSON-LD, per-page meta titles/descriptions - #31

Merged
joaodibba merged 1 commit into
TypeComposer:mainfrom
lucas-spin:feat/seo-indexability
Jun 12, 2026
Merged

feat(seo): robots.txt, sitemap.xml, llms.txt, canonical URL, JSON-LD, per-page meta titles/descriptions#31
joaodibba merged 1 commit into
TypeComposer:mainfrom
lucas-spin:feat/seo-indexability

Conversation

@lucas-spin

Copy link
Copy Markdown
Contributor

What changed and why

SEO/indexability improvements based on Gonçalo's audit, as requested by João. Highest-value static wins with no new npm dependencies, no unrelated churn, and no conflict with #30 (already merged).


Architecture findings (pre-PR)

ConcernFinding
Routing modehistory: "hash" — all docs URLs are #/docs/…
Hosting fallbackpublic/.htaccess already rewrites all paths → index.html
Static file servingVite copies public/ verbatim to dist/
Existing metadataindex.html had generic OG/Twitter tags but no canonical, no JSON-LD, no robots.txt, no sitemap, no per-page titles
PR #30Merged before this PR — docs/skills route is live ✓
Hash URL + canonicalsHash fragments are not real URLs → single canonical at root is correct; per-page canonicals add no benefit without SSR
Clean URL migrationDeferred — server must be verified to support try_files / Apache rewrite for every /docs/* path; .htaccess is present but hosting needs confirmation

Changes

FileWhat
public/robots.txtAllow all crawlers; Sitemap: directive pointing to sitemap
public/sitemap.xml29 <url> entries for every registered route (home, all docs pages, playground)
public/llms.txtllmstxt.org convention — machine-readable site manifest for LLM indexers (GPTBot, Claude, Gemini)
index.html<link rel="canonical"> → root URL; two JSON-LD blocks (WebSite + SoftwareApplication); improved title/description copy ("zero-HTML" framing)
src/utils/seo.tsNewupdatePageMeta(pathname) with per-route <title> + <meta name="description"> map (29 routes)
src/views/elements/Base.tsCall updatePageMeta(Router.pathname) in BaseView constructor — fires on every docs page navigation

What was deferred / not included

ItemReason
Clean (history-mode) URLsRequires confirming hosting supports path rewrites for all/docs/* URLs before enabling history: "browser" in the router — wrong call without server verification; the .htaccess is present but needs testing
Per-page canonical URLsNo benefit over root canonical with hash routing + no SSR
Prerendering / static HTMLOut of scope — would require either SSR or a prerender plugin

Validation

npm install
npm run build # ✓ built in 11.11s — zero errors, zero new warnings

Build confirms all 3 static files are copied to dist/ (robots.txt, sitemap.xml, llms.txt), index.html contains canonical and JSON-LD, and seo.ts is tree-shaken cleanly into the bundle.

Diff: 6 files — 430 insertions, 9 deletions (index.html copy improvements).

Reviewer

@zico15

… per-page meta
P0/P1 indexability improvements based on Gonçalo's audit:
- public/robots.txt — allow all crawlers, point to sitemap
- public/sitemap.xml — 29 URL entries covering all docs routes + home + playground
- public/llms.txt — LLM-friendly site manifest (llmstxt.org convention)
- index.html — canonical <link> pointing to https://typecomposer.com/;
two JSON-LD blocks (WebSite + SoftwareApplication);
improved global title/description ('zero-HTML' framing)
- src/utils/seo.ts — updatePageMeta() utility: per-route <title> and
<meta name=description> map (29 routes); called on each
route activation so browser history and JS-rendered tabs
show meaningful page titles
- src/views/elements/Base.ts — call updatePageMeta(Router.pathname) in BaseView
constructor so every docs page updates the document title
Hash routing constraint: canonical stays fixed at the root URL since hash
fragments are not real URLs (no per-page canonical benefit without SSR).
Clean URL migration deferred — requires hosting config validation.
Build: vite build ✓ 11.11s, 0 errors
Resolves: robots.txt missing, no sitemap, no per-page titles/descriptions
@joaodibba
joaodibba merged commit f104878 into TypeComposer:mainJun 12, 2026
1 check failed
joaodibba pushed a commit that referenced this pull request Jun 12, 2026
… URLs
SEO P0 follow-up to PRs #29#31.
Problem: hash routing (/#/docs/skills) is not indexable by search engines
because the fragment is never sent to the server. Direct deep-links also 404
without a server-side SPA fallback.
Changes:
- src/router/router.ts: history: "hash" → history: "browser" — enables clean
URLs like /docs/skills, /docs/getting-started, /playground
- vite.config.js: base: "./" → base: "/" — absolute asset paths prevent
broken asset loads when navigating to nested routes (e.g. /docs/skills)
- public/.htaccess: improve comments; SPA fallback rule was already correct
(rewrite all non-file/non-dir requests to /index.html) and remains unchanged
in logic — confirmed present before this PR
- src/utils/seo.ts: add per-route canonical <link> injection (setCanonical);
now meaningful because each route has a real URL; updated Router description
to remove "hash" reference; root canonical in index.html stays https://typecomposer.com/
- public/sitemap.xml: strip /#/ from all 29 URLs (e.g. /#/docs/skills →
/docs/skills, /#/playground → /playground)
- public/llms.txt: strip /#/ from all 29 doc links; update Router key concept
description to reference browser history mode
- index.html: update JSON-LD SearchAction target from /#/docs/… to /docs/…
Hosting note (⚠ must verify after deploy):
The .htaccess SPA fallback was already present in the repo (added before PR #31)
and is confirmed to contain the correct RewriteRule. Direct deep-link indexability
(e.g. https://typecomposer.com/docs/skills returning 200 not 404) requires the
Apache server to honour this .htaccess. Test with:
curl -I https://typecomposer.com/docs/skills
Expected: HTTP/2 200, not 301/302/404.
Build: npm run build — ✓ 2405 modules, no errors
Reviewer: @zico15
joaodibba added a commit that referenced this pull request Jun 12, 2026
…e URLs (#32)
## SEO P0 — Clean URLs via Browser History Routing
Follow-up to #29, #30, #31.
### Problem
Hash routing (`/#/docs/skills`) is not indexable by search engines — the
fragment after `#` is never sent to the server, so Googlebot sees only
`https://typecomposer.com/` for every page. Direct deep-links to
`/docs/skills` also 404 without a proper SPA fallback. This means the
sitemap, per-route canonicals, and per-page meta added in #31 cannot
deliver their full SEO value.
### Solution
Switch `Router.create` from `history: "hash"` to `history: "browser"`
(HTML5 `pushState`). The server-side SPA fallback (`.htaccess`) was
**already present in the repo** before this PR and contains the correct
`RewriteRule ^.*$ /index.html [L,QSA]` — so direct deep-links will be
served correctly on the Apache-hosted production site once this PR is
merged and deployed.
---
### Files Changed (7)
| File | Change |
|------|--------|
| `src/router/router.ts` | `history: "hash"` → `history: "browser"` |
| `vite.config.js` | `base: "./"` → `base: "/"` — absolute asset paths
prevent broken JS/CSS loads when a user navigates directly to a nested
route like `/docs/skills` (relative `./assets/` would resolve to
`/docs/assets/`) |
| `src/utils/seo.ts` | `updatePageMeta()` updates `<title>` and `<meta
name="description">` per route. Runtime `setCanonical()` workaround
**removed** — the static root canonical in `index.html` covers the home
route, and `sitemap.xml` provides authoritative clean-URL canonicals for
all 29 pages without requiring JS. |
| `public/sitemap.xml` | Strip `#/` from all 29 URLs (`/#/docs/skills` →
`/docs/skills`, `/#/playground` → `/playground`) |
| `public/llms.txt` | Same URL migration for all 29 doc links; Router
key concept updated to reference `history: "browser"` |
| `index.html` | JSON-LD `SearchAction.target` updated from
`/#/docs/{search_term_string}` → `/docs/{search_term_string}`; canonical
comment tidied |
| `public/.htaccess` | Comments improved for clarity; **rewrite rule
logic unchanged** — it was already correct |
---
### Build Validation (commit 2)
```
npm run build
✓ 2405 modules transformed — no errors, no type errors
```
```
dist/.htaccess ✓ present (copied from public/)
dist/sitemap.xml ✓ 0 hash URLs remaining
dist/llms.txt ✓ 0 hash URLs remaining
dist/index.html ✓ assets load from /assets/* (absolute paths)
dist/index.html ✓ root canonical <https://typecomposer.com/> present
src/utils/seo.ts ✓ setCanonical() removed
src/utils/seo.ts ✓ CANONICAL_BASE constant removed
```
---
### ⚠️ Hosting Verification Required Before Release
The `.htaccess` SPA fallback must be honoured by the production Apache
server. Please test after deploy:
```bash
# Direct deep-link must return HTTP 200, not 301/302/404
curl -I https://typecomposer.com/docs/skills
# Expected: HTTP/2 200
curl -I https://typecomposer.com/docs/getting-started
# Expected: HTTP/2 200
curl -I https://typecomposer.com/playground
# Expected: HTTP/2 200
# Assets must still load correctly
curl -I https://typecomposer.com/typecomposer.svg
# Expected: HTTP/2 200
curl -I https://typecomposer.com/sitemap.xml
# Expected: HTTP/2 200
```
If the Apache server requires `AllowOverride All` in its vhost config,
that must be enabled separately by the hosting admin. If `.htaccess` is
not supported, a `_redirects` (Netlify) or `vercel.json` equivalent
would be needed — but the existing `.htaccess` confirms Apache is the
target host.
---
### /docs/skills → Agent Skills ✓
Route `docs/skills` maps to `BaseView` and `PAGE_META["docs/skills"]` is
unchanged:
- Title: **Agent Skills | TypeComposer**
- Description: _Use TypeComposer to build AI agent skills…_
---
cc @zico15
zico15 added a commit that referenced this pull request Jun 12, 2026
…d-wasm and component registration (#33)
## Summary
Finishes and unblocks PR #15 (originally opened by @Copilot, which had 4
merge conflicts with `main`).
This branch is identical to the Copilot PR branch but with a merge
commit that resolves all 4 conflicts against current `main`.
---
## What this PR does
Migrates `PlaygroundView` from `@codesandbox/sandpack-client` (remote
compilation) to **fully browser-based compilation** using
`esbuild-wasm`, satisfying all acceptance criteria from issue #14.
### Changes
| File | Change |
|---|---|
| `src/utils/browserCompiler.ts` (**new**) | esbuild-wasm in-browser TS
compiler with virtual file system plugin |
| `src/components/editor/MonacoEditor.ts` (**new**) | Monaco Editor
wrapped as a TypeComposer `Component` |
| `src/views/playground/PlaygroundView.ts` | Replaced
`loadSandpackClient` with `compileAndRun()`, iframe injection via blob
URL + import map, Monaco split-view |
| `src/styles/` | Refactored `src/style.scss` → `src/styles/index.css` +
`src/styles/style.scss` (Tailwind v4) |
| `package.json` | Removed `@codesandbox/sandpack-client`; added
`esbuild-wasm ^0.25.10`, `monaco-editor ^0.54.0`, `@monaco-editor/loader
^1.5.0`, Tailwind v4 + `@tailwindcss/vite`; moved `typecomposer-plugin`
to `devDependencies`; bumped `typecomposer` to `^0.1.56` |
| `vite.config.ts` | Renamed from `.js`, added `tailwindcss()` plugin,
`base: "/"` (browser-history routing), scss preprocessor config |
### TypeComposer Component Registration
TypeComposer components (`DivElement`, `VBox`, `HBox`, etc.) are Web
Components that must be registered via `customElements.define()` before
instantiation. The playground injects an import map pointing
`typecomposer` at `esm.sh/typecomposer`, which makes the CDN-loaded
classes available to user code. `typecomposer` is marked `external` in
esbuild so imports pass through to the import map.
### Merge Conflict Resolution (vs PR #15)
The original Copilot branch diverged from `main` after `main` received
SEO/routing commits (#31, #32). This PR adds one merge commit that:
1. Bumps `typecomposer` `^0.1.54` → `^0.1.56` 2. Moves `typecomposer-plugin` to `devDependencies`
3. Fixes `vite.config.ts` `base: "./"` → `base: "/"` (required for
browser-history routing from main)
4. Adds `scss: { api: "modern-compiler" }` preprocessor config from main
5. Regenerates `package-lock.json`
---
## Build result
```
✓ 3452 modules transformed.
✓ built in 15.16s
```
---
## Acceptance criteria checklist
- [x] Remove `loadSandpackClient` and `bundlerURL` dependency
- [x] Integrate `esbuild-wasm` to compile TypeScript in the browser
- [x] Preserve `files` object / multi-file compilation
- [x] `IFrameElement` executes compiled JS via blob URL in sandboxed
iframe
- [x] Compilation and runtime errors displayed clearly
- [x] Current layout/styles maintained
- [x] TypeComposer Web Components registered before user code runs
(import map + CDN)
Closes#14
Supersedes #15 (conflict-free replacement)
cc @zico15@joaodibba
Sign up for freeto 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

@lucas-spin@joaodibba
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(seo): robots.txt, sitemap.xml, llms.txt, canonical URL, JSON-LD, per-page meta titles/descriptions - #31

Merged
joaodibba merged 1 commit into
TypeComposer:mainfrom
lucas-spin:feat/seo-indexability
Jun 12, 2026
Merged

feat(seo): robots.txt, sitemap.xml, llms.txt, canonical URL, JSON-LD, per-page meta titles/descriptions#31
joaodibba merged 1 commit into
TypeComposer:mainfrom
lucas-spin:feat/seo-indexability

Conversation

@lucas-spin

Copy link
Copy Markdown
Contributor

What changed and why

SEO/indexability improvements based on Gonçalo's audit, as requested by João. Highest-value static wins with no new npm dependencies, no unrelated churn, and no conflict with #30 (already merged).


Architecture findings (pre-PR)

ConcernFinding
Routing modehistory: "hash" — all docs URLs are #/docs/…
Hosting fallbackpublic/.htaccess already rewrites all paths → index.html
Static file servingVite copies public/ verbatim to dist/
Existing metadataindex.html had generic OG/Twitter tags but no canonical, no JSON-LD, no robots.txt, no sitemap, no per-page titles
PR #30Merged before this PR — docs/skills route is live ✓
Hash URL + canonicalsHash fragments are not real URLs → single canonical at root is correct; per-page canonicals add no benefit without SSR
Clean URL migrationDeferred — server must be verified to support try_files / Apache rewrite for every /docs/* path; .htaccess is present but hosting needs confirmation

Changes

FileWhat
public/robots.txtAllow all crawlers; Sitemap: directive pointing to sitemap
public/sitemap.xml29 <url> entries for every registered route (home, all docs pages, playground)
public/llms.txtllmstxt.org convention — machine-readable site manifest for LLM indexers (GPTBot, Claude, Gemini)
index.html<link rel="canonical"> → root URL; two JSON-LD blocks (WebSite + SoftwareApplication); improved title/description copy ("zero-HTML" framing)
src/utils/seo.tsNewupdatePageMeta(pathname) with per-route <title> + <meta name="description"> map (29 routes)
src/views/elements/Base.tsCall updatePageMeta(Router.pathname) in BaseView constructor — fires on every docs page navigation

What was deferred / not included

ItemReason
Clean (history-mode) URLsRequires confirming hosting supports path rewrites for all/docs/* URLs before enabling history: "browser" in the router — wrong call without server verification; the .htaccess is present but needs testing
Per-page canonical URLsNo benefit over root canonical with hash routing + no SSR
Prerendering / static HTMLOut of scope — would require either SSR or a prerender plugin

Validation

npm install
npm run build # ✓ built in 11.11s — zero errors, zero new warnings

Build confirms all 3 static files are copied to dist/ (robots.txt, sitemap.xml, llms.txt), index.html contains canonical and JSON-LD, and seo.ts is tree-shaken cleanly into the bundle.

Diff: 6 files — 430 insertions, 9 deletions (index.html copy improvements).

Reviewer

@zico15

… per-page meta
P0/P1 indexability improvements based on Gonçalo's audit:
- public/robots.txt — allow all crawlers, point to sitemap
- public/sitemap.xml — 29 URL entries covering all docs routes + home + playground
- public/llms.txt — LLM-friendly site manifest (llmstxt.org convention)
- index.html — canonical <link> pointing to https://typecomposer.com/;
two JSON-LD blocks (WebSite + SoftwareApplication);
improved global title/description ('zero-HTML' framing)
- src/utils/seo.ts — updatePageMeta() utility: per-route <title> and
<meta name=description> map (29 routes); called on each
route activation so browser history and JS-rendered tabs
show meaningful page titles
- src/views/elements/Base.ts — call updatePageMeta(Router.pathname) in BaseView
constructor so every docs page updates the document title
Hash routing constraint: canonical stays fixed at the root URL since hash
fragments are not real URLs (no per-page canonical benefit without SSR).
Clean URL migration deferred — requires hosting config validation.
Build: vite build ✓ 11.11s, 0 errors
Resolves: robots.txt missing, no sitemap, no per-page titles/descriptions
@joaodibba
joaodibba merged commit f104878 into TypeComposer:mainJun 12, 2026
1 check failed
joaodibba pushed a commit that referenced this pull request Jun 12, 2026
… URLs
SEO P0 follow-up to PRs #29#31.
Problem: hash routing (/#/docs/skills) is not indexable by search engines
because the fragment is never sent to the server. Direct deep-links also 404
without a server-side SPA fallback.
Changes:
- src/router/router.ts: history: "hash" → history: "browser" — enables clean
URLs like /docs/skills, /docs/getting-started, /playground
- vite.config.js: base: "./" → base: "/" — absolute asset paths prevent
broken asset loads when navigating to nested routes (e.g. /docs/skills)
- public/.htaccess: improve comments; SPA fallback rule was already correct
(rewrite all non-file/non-dir requests to /index.html) and remains unchanged
in logic — confirmed present before this PR
- src/utils/seo.ts: add per-route canonical <link> injection (setCanonical);
now meaningful because each route has a real URL; updated Router description
to remove "hash" reference; root canonical in index.html stays https://typecomposer.com/
- public/sitemap.xml: strip /#/ from all 29 URLs (e.g. /#/docs/skills →
/docs/skills, /#/playground → /playground)
- public/llms.txt: strip /#/ from all 29 doc links; update Router key concept
description to reference browser history mode
- index.html: update JSON-LD SearchAction target from /#/docs/… to /docs/…
Hosting note (⚠ must verify after deploy):
The .htaccess SPA fallback was already present in the repo (added before PR #31)
and is confirmed to contain the correct RewriteRule. Direct deep-link indexability
(e.g. https://typecomposer.com/docs/skills returning 200 not 404) requires the
Apache server to honour this .htaccess. Test with:
curl -I https://typecomposer.com/docs/skills
Expected: HTTP/2 200, not 301/302/404.
Build: npm run build — ✓ 2405 modules, no errors
Reviewer: @zico15
joaodibba added a commit that referenced this pull request Jun 12, 2026
…e URLs (#32)
## SEO P0 — Clean URLs via Browser History Routing
Follow-up to #29, #30, #31.
### Problem
Hash routing (`/#/docs/skills`) is not indexable by search engines — the
fragment after `#` is never sent to the server, so Googlebot sees only
`https://typecomposer.com/` for every page. Direct deep-links to
`/docs/skills` also 404 without a proper SPA fallback. This means the
sitemap, per-route canonicals, and per-page meta added in #31 cannot
deliver their full SEO value.
### Solution
Switch `Router.create` from `history: "hash"` to `history: "browser"`
(HTML5 `pushState`). The server-side SPA fallback (`.htaccess`) was
**already present in the repo** before this PR and contains the correct
`RewriteRule ^.*$ /index.html [L,QSA]` — so direct deep-links will be
served correctly on the Apache-hosted production site once this PR is
merged and deployed.
---
### Files Changed (7)
| File | Change |
|------|--------|
| `src/router/router.ts` | `history: "hash"` → `history: "browser"` |
| `vite.config.js` | `base: "./"` → `base: "/"` — absolute asset paths
prevent broken JS/CSS loads when a user navigates directly to a nested
route like `/docs/skills` (relative `./assets/` would resolve to
`/docs/assets/`) |
| `src/utils/seo.ts` | `updatePageMeta()` updates `<title>` and `<meta
name="description">` per route. Runtime `setCanonical()` workaround
**removed** — the static root canonical in `index.html` covers the home
route, and `sitemap.xml` provides authoritative clean-URL canonicals for
all 29 pages without requiring JS. |
| `public/sitemap.xml` | Strip `#/` from all 29 URLs (`/#/docs/skills` →
`/docs/skills`, `/#/playground` → `/playground`) |
| `public/llms.txt` | Same URL migration for all 29 doc links; Router
key concept updated to reference `history: "browser"` |
| `index.html` | JSON-LD `SearchAction.target` updated from
`/#/docs/{search_term_string}` → `/docs/{search_term_string}`; canonical
comment tidied |
| `public/.htaccess` | Comments improved for clarity; **rewrite rule
logic unchanged** — it was already correct |
---
### Build Validation (commit 2)
```
npm run build
✓ 2405 modules transformed — no errors, no type errors
```
```
dist/.htaccess ✓ present (copied from public/)
dist/sitemap.xml ✓ 0 hash URLs remaining
dist/llms.txt ✓ 0 hash URLs remaining
dist/index.html ✓ assets load from /assets/* (absolute paths)
dist/index.html ✓ root canonical <https://typecomposer.com/> present
src/utils/seo.ts ✓ setCanonical() removed
src/utils/seo.ts ✓ CANONICAL_BASE constant removed
```
---
### ⚠️ Hosting Verification Required Before Release
The `.htaccess` SPA fallback must be honoured by the production Apache
server. Please test after deploy:
```bash
# Direct deep-link must return HTTP 200, not 301/302/404
curl -I https://typecomposer.com/docs/skills
# Expected: HTTP/2 200
curl -I https://typecomposer.com/docs/getting-started
# Expected: HTTP/2 200
curl -I https://typecomposer.com/playground
# Expected: HTTP/2 200
# Assets must still load correctly
curl -I https://typecomposer.com/typecomposer.svg
# Expected: HTTP/2 200
curl -I https://typecomposer.com/sitemap.xml
# Expected: HTTP/2 200
```
If the Apache server requires `AllowOverride All` in its vhost config,
that must be enabled separately by the hosting admin. If `.htaccess` is
not supported, a `_redirects` (Netlify) or `vercel.json` equivalent
would be needed — but the existing `.htaccess` confirms Apache is the
target host.
---
### /docs/skills → Agent Skills ✓
Route `docs/skills` maps to `BaseView` and `PAGE_META["docs/skills"]` is
unchanged:
- Title: **Agent Skills | TypeComposer**
- Description: _Use TypeComposer to build AI agent skills…_
---
cc @zico15
zico15 added a commit that referenced this pull request Jun 12, 2026
…d-wasm and component registration (#33)
## Summary
Finishes and unblocks PR #15 (originally opened by @Copilot, which had 4
merge conflicts with `main`).
This branch is identical to the Copilot PR branch but with a merge
commit that resolves all 4 conflicts against current `main`.
---
## What this PR does
Migrates `PlaygroundView` from `@codesandbox/sandpack-client` (remote
compilation) to **fully browser-based compilation** using
`esbuild-wasm`, satisfying all acceptance criteria from issue #14.
### Changes
| File | Change |
|---|---|
| `src/utils/browserCompiler.ts` (**new**) | esbuild-wasm in-browser TS
compiler with virtual file system plugin |
| `src/components/editor/MonacoEditor.ts` (**new**) | Monaco Editor
wrapped as a TypeComposer `Component` |
| `src/views/playground/PlaygroundView.ts` | Replaced
`loadSandpackClient` with `compileAndRun()`, iframe injection via blob
URL + import map, Monaco split-view |
| `src/styles/` | Refactored `src/style.scss` → `src/styles/index.css` +
`src/styles/style.scss` (Tailwind v4) |
| `package.json` | Removed `@codesandbox/sandpack-client`; added
`esbuild-wasm ^0.25.10`, `monaco-editor ^0.54.0`, `@monaco-editor/loader
^1.5.0`, Tailwind v4 + `@tailwindcss/vite`; moved `typecomposer-plugin`
to `devDependencies`; bumped `typecomposer` to `^0.1.56` |
| `vite.config.ts` | Renamed from `.js`, added `tailwindcss()` plugin,
`base: "/"` (browser-history routing), scss preprocessor config |
### TypeComposer Component Registration
TypeComposer components (`DivElement`, `VBox`, `HBox`, etc.) are Web
Components that must be registered via `customElements.define()` before
instantiation. The playground injects an import map pointing
`typecomposer` at `esm.sh/typecomposer`, which makes the CDN-loaded
classes available to user code. `typecomposer` is marked `external` in
esbuild so imports pass through to the import map.
### Merge Conflict Resolution (vs PR #15)
The original Copilot branch diverged from `main` after `main` received
SEO/routing commits (#31, #32). This PR adds one merge commit that:
1. Bumps `typecomposer` `^0.1.54` → `^0.1.56` 2. Moves `typecomposer-plugin` to `devDependencies`
3. Fixes `vite.config.ts` `base: "./"` → `base: "/"` (required for
browser-history routing from main)
4. Adds `scss: { api: "modern-compiler" }` preprocessor config from main
5. Regenerates `package-lock.json`
---
## Build result
```
✓ 3452 modules transformed.
✓ built in 15.16s
```
---
## Acceptance criteria checklist
- [x] Remove `loadSandpackClient` and `bundlerURL` dependency
- [x] Integrate `esbuild-wasm` to compile TypeScript in the browser
- [x] Preserve `files` object / multi-file compilation
- [x] `IFrameElement` executes compiled JS via blob URL in sandboxed
iframe
- [x] Compilation and runtime errors displayed clearly
- [x] Current layout/styles maintained
- [x] TypeComposer Web Components registered before user code runs
(import map + CDN)
Closes#14
Supersedes #15 (conflict-free replacement)
cc @zico15@joaodibba
Sign up for freeto 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

@lucas-spin@joaodibba
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

feat(seo): robots.txt, sitemap.xml, llms.txt, canonical URL, JSON-LD, per-page meta titles/descriptions - #31

Merged
joaodibba merged 1 commit into
TypeComposer:mainfrom
lucas-spin:feat/seo-indexability
Jun 12, 2026
Merged

feat(seo): robots.txt, sitemap.xml, llms.txt, canonical URL, JSON-LD, per-page meta titles/descriptions#31
joaodibba merged 1 commit into
TypeComposer:mainfrom
lucas-spin:feat/seo-indexability

Conversation

@lucas-spin

Copy link
Copy Markdown
Contributor

What changed and why

SEO/indexability improvements based on Gonçalo's audit, as requested by João. Highest-value static wins with no new npm dependencies, no unrelated churn, and no conflict with #30 (already merged).


Architecture findings (pre-PR)

ConcernFinding
Routing modehistory: "hash" — all docs URLs are #/docs/…
Hosting fallbackpublic/.htaccess already rewrites all paths → index.html
Static file servingVite copies public/ verbatim to dist/
Existing metadataindex.html had generic OG/Twitter tags but no canonical, no JSON-LD, no robots.txt, no sitemap, no per-page titles
PR #30Merged before this PR — docs/skills route is live ✓
Hash URL + canonicalsHash fragments are not real URLs → single canonical at root is correct; per-page canonicals add no benefit without SSR
Clean URL migrationDeferred — server must be verified to support try_files / Apache rewrite for every /docs/* path; .htaccess is present but hosting needs confirmation

Changes

FileWhat
public/robots.txtAllow all crawlers; Sitemap: directive pointing to sitemap
public/sitemap.xml29 <url> entries for every registered route (home, all docs pages, playground)
public/llms.txtllmstxt.org convention — machine-readable site manifest for LLM indexers (GPTBot, Claude, Gemini)
index.html<link rel="canonical"> → root URL; two JSON-LD blocks (WebSite + SoftwareApplication); improved title/description copy ("zero-HTML" framing)
src/utils/seo.tsNewupdatePageMeta(pathname) with per-route <title> + <meta name="description"> map (29 routes)
src/views/elements/Base.tsCall updatePageMeta(Router.pathname) in BaseView constructor — fires on every docs page navigation

What was deferred / not included

ItemReason
Clean (history-mode) URLsRequires confirming hosting supports path rewrites for all/docs/* URLs before enabling history: "browser" in the router — wrong call without server verification; the .htaccess is present but needs testing
Per-page canonical URLsNo benefit over root canonical with hash routing + no SSR
Prerendering / static HTMLOut of scope — would require either SSR or a prerender plugin

Validation

npm install
npm run build # ✓ built in 11.11s — zero errors, zero new warnings

Build confirms all 3 static files are copied to dist/ (robots.txt, sitemap.xml, llms.txt), index.html contains canonical and JSON-LD, and seo.ts is tree-shaken cleanly into the bundle.

Diff: 6 files — 430 insertions, 9 deletions (index.html copy improvements).

Reviewer

@zico15

… per-page meta
P0/P1 indexability improvements based on Gonçalo's audit:
- public/robots.txt — allow all crawlers, point to sitemap
- public/sitemap.xml — 29 URL entries covering all docs routes + home + playground
- public/llms.txt — LLM-friendly site manifest (llmstxt.org convention)
- index.html — canonical <link> pointing to https://typecomposer.com/;
two JSON-LD blocks (WebSite + SoftwareApplication);
improved global title/description ('zero-HTML' framing)
- src/utils/seo.ts — updatePageMeta() utility: per-route <title> and
<meta name=description> map (29 routes); called on each
route activation so browser history and JS-rendered tabs
show meaningful page titles
- src/views/elements/Base.ts — call updatePageMeta(Router.pathname) in BaseView
constructor so every docs page updates the document title
Hash routing constraint: canonical stays fixed at the root URL since hash
fragments are not real URLs (no per-page canonical benefit without SSR).
Clean URL migration deferred — requires hosting config validation.
Build: vite build ✓ 11.11s, 0 errors
Resolves: robots.txt missing, no sitemap, no per-page titles/descriptions
@joaodibba
joaodibba merged commit f104878 into TypeComposer:mainJun 12, 2026
1 check failed
joaodibba pushed a commit that referenced this pull request Jun 12, 2026
… URLs
SEO P0 follow-up to PRs #29#31.
Problem: hash routing (/#/docs/skills) is not indexable by search engines
because the fragment is never sent to the server. Direct deep-links also 404
without a server-side SPA fallback.
Changes:
- src/router/router.ts: history: "hash" → history: "browser" — enables clean
URLs like /docs/skills, /docs/getting-started, /playground
- vite.config.js: base: "./" → base: "/" — absolute asset paths prevent
broken asset loads when navigating to nested routes (e.g. /docs/skills)
- public/.htaccess: improve comments; SPA fallback rule was already correct
(rewrite all non-file/non-dir requests to /index.html) and remains unchanged
in logic — confirmed present before this PR
- src/utils/seo.ts: add per-route canonical <link> injection (setCanonical);
now meaningful because each route has a real URL; updated Router description
to remove "hash" reference; root canonical in index.html stays https://typecomposer.com/
- public/sitemap.xml: strip /#/ from all 29 URLs (e.g. /#/docs/skills →
/docs/skills, /#/playground → /playground)
- public/llms.txt: strip /#/ from all 29 doc links; update Router key concept
description to reference browser history mode
- index.html: update JSON-LD SearchAction target from /#/docs/… to /docs/…
Hosting note (⚠ must verify after deploy):
The .htaccess SPA fallback was already present in the repo (added before PR #31)
and is confirmed to contain the correct RewriteRule. Direct deep-link indexability
(e.g. https://typecomposer.com/docs/skills returning 200 not 404) requires the
Apache server to honour this .htaccess. Test with:
curl -I https://typecomposer.com/docs/skills
Expected: HTTP/2 200, not 301/302/404.
Build: npm run build — ✓ 2405 modules, no errors
Reviewer: @zico15
joaodibba added a commit that referenced this pull request Jun 12, 2026
…e URLs (#32)
## SEO P0 — Clean URLs via Browser History Routing
Follow-up to #29, #30, #31.
### Problem
Hash routing (`/#/docs/skills`) is not indexable by search engines — the
fragment after `#` is never sent to the server, so Googlebot sees only
`https://typecomposer.com/` for every page. Direct deep-links to
`/docs/skills` also 404 without a proper SPA fallback. This means the
sitemap, per-route canonicals, and per-page meta added in #31 cannot
deliver their full SEO value.
### Solution
Switch `Router.create` from `history: "hash"` to `history: "browser"`
(HTML5 `pushState`). The server-side SPA fallback (`.htaccess`) was
**already present in the repo** before this PR and contains the correct
`RewriteRule ^.*$ /index.html [L,QSA]` — so direct deep-links will be
served correctly on the Apache-hosted production site once this PR is
merged and deployed.
---
### Files Changed (7)
| File | Change |
|------|--------|
| `src/router/router.ts` | `history: "hash"` → `history: "browser"` |
| `vite.config.js` | `base: "./"` → `base: "/"` — absolute asset paths
prevent broken JS/CSS loads when a user navigates directly to a nested
route like `/docs/skills` (relative `./assets/` would resolve to
`/docs/assets/`) |
| `src/utils/seo.ts` | `updatePageMeta()` updates `<title>` and `<meta
name="description">` per route. Runtime `setCanonical()` workaround
**removed** — the static root canonical in `index.html` covers the home
route, and `sitemap.xml` provides authoritative clean-URL canonicals for
all 29 pages without requiring JS. |
| `public/sitemap.xml` | Strip `#/` from all 29 URLs (`/#/docs/skills` →
`/docs/skills`, `/#/playground` → `/playground`) |
| `public/llms.txt` | Same URL migration for all 29 doc links; Router
key concept updated to reference `history: "browser"` |
| `index.html` | JSON-LD `SearchAction.target` updated from
`/#/docs/{search_term_string}` → `/docs/{search_term_string}`; canonical
comment tidied |
| `public/.htaccess` | Comments improved for clarity; **rewrite rule
logic unchanged** — it was already correct |
---
### Build Validation (commit 2)
```
npm run build
✓ 2405 modules transformed — no errors, no type errors
```
```
dist/.htaccess ✓ present (copied from public/)
dist/sitemap.xml ✓ 0 hash URLs remaining
dist/llms.txt ✓ 0 hash URLs remaining
dist/index.html ✓ assets load from /assets/* (absolute paths)
dist/index.html ✓ root canonical <https://typecomposer.com/> present
src/utils/seo.ts ✓ setCanonical() removed
src/utils/seo.ts ✓ CANONICAL_BASE constant removed
```
---
### ⚠️ Hosting Verification Required Before Release
The `.htaccess` SPA fallback must be honoured by the production Apache
server. Please test after deploy:
```bash
# Direct deep-link must return HTTP 200, not 301/302/404
curl -I https://typecomposer.com/docs/skills
# Expected: HTTP/2 200
curl -I https://typecomposer.com/docs/getting-started
# Expected: HTTP/2 200
curl -I https://typecomposer.com/playground
# Expected: HTTP/2 200
# Assets must still load correctly
curl -I https://typecomposer.com/typecomposer.svg
# Expected: HTTP/2 200
curl -I https://typecomposer.com/sitemap.xml
# Expected: HTTP/2 200
```
If the Apache server requires `AllowOverride All` in its vhost config,
that must be enabled separately by the hosting admin. If `.htaccess` is
not supported, a `_redirects` (Netlify) or `vercel.json` equivalent
would be needed — but the existing `.htaccess` confirms Apache is the
target host.
---
### /docs/skills → Agent Skills ✓
Route `docs/skills` maps to `BaseView` and `PAGE_META["docs/skills"]` is
unchanged:
- Title: **Agent Skills | TypeComposer**
- Description: _Use TypeComposer to build AI agent skills…_
---
cc @zico15
zico15 added a commit that referenced this pull request Jun 12, 2026
…d-wasm and component registration (#33)
## Summary
Finishes and unblocks PR #15 (originally opened by @Copilot, which had 4
merge conflicts with `main`).
This branch is identical to the Copilot PR branch but with a merge
commit that resolves all 4 conflicts against current `main`.
---
## What this PR does
Migrates `PlaygroundView` from `@codesandbox/sandpack-client` (remote
compilation) to **fully browser-based compilation** using
`esbuild-wasm`, satisfying all acceptance criteria from issue #14.
### Changes
| File | Change |
|---|---|
| `src/utils/browserCompiler.ts` (**new**) | esbuild-wasm in-browser TS
compiler with virtual file system plugin |
| `src/components/editor/MonacoEditor.ts` (**new**) | Monaco Editor
wrapped as a TypeComposer `Component` |
| `src/views/playground/PlaygroundView.ts` | Replaced
`loadSandpackClient` with `compileAndRun()`, iframe injection via blob
URL + import map, Monaco split-view |
| `src/styles/` | Refactored `src/style.scss` → `src/styles/index.css` +
`src/styles/style.scss` (Tailwind v4) |
| `package.json` | Removed `@codesandbox/sandpack-client`; added
`esbuild-wasm ^0.25.10`, `monaco-editor ^0.54.0`, `@monaco-editor/loader
^1.5.0`, Tailwind v4 + `@tailwindcss/vite`; moved `typecomposer-plugin`
to `devDependencies`; bumped `typecomposer` to `^0.1.56` |
| `vite.config.ts` | Renamed from `.js`, added `tailwindcss()` plugin,
`base: "/"` (browser-history routing), scss preprocessor config |
### TypeComposer Component Registration
TypeComposer components (`DivElement`, `VBox`, `HBox`, etc.) are Web
Components that must be registered via `customElements.define()` before
instantiation. The playground injects an import map pointing
`typecomposer` at `esm.sh/typecomposer`, which makes the CDN-loaded
classes available to user code. `typecomposer` is marked `external` in
esbuild so imports pass through to the import map.
### Merge Conflict Resolution (vs PR #15)
The original Copilot branch diverged from `main` after `main` received
SEO/routing commits (#31, #32). This PR adds one merge commit that:
1. Bumps `typecomposer` `^0.1.54` → `^0.1.56` 2. Moves `typecomposer-plugin` to `devDependencies`
3. Fixes `vite.config.ts` `base: "./"` → `base: "/"` (required for
browser-history routing from main)
4. Adds `scss: { api: "modern-compiler" }` preprocessor config from main
5. Regenerates `package-lock.json`
---
## Build result
```
✓ 3452 modules transformed.
✓ built in 15.16s
```
---
## Acceptance criteria checklist
- [x] Remove `loadSandpackClient` and `bundlerURL` dependency
- [x] Integrate `esbuild-wasm` to compile TypeScript in the browser
- [x] Preserve `files` object / multi-file compilation
- [x] `IFrameElement` executes compiled JS via blob URL in sandboxed
iframe
- [x] Compilation and runtime errors displayed clearly
- [x] Current layout/styles maintained
- [x] TypeComposer Web Components registered before user code runs
(import map + CDN)
Closes#14
Supersedes #15 (conflict-free replacement)
cc @zico15@joaodibba
Sign up for freeto 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

@lucas-spin@joaodibba
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(seo): robots.txt, sitemap.xml, llms.txt, canonical URL, JSON-LD, per-page meta titles/descriptions - #31

Merged
joaodibba merged 1 commit into
TypeComposer:mainfrom
lucas-spin:feat/seo-indexability
Jun 12, 2026
Merged

feat(seo): robots.txt, sitemap.xml, llms.txt, canonical URL, JSON-LD, per-page meta titles/descriptions#31
joaodibba merged 1 commit into
TypeComposer:mainfrom
lucas-spin:feat/seo-indexability

Conversation

@lucas-spin

Copy link
Copy Markdown
Contributor

What changed and why

SEO/indexability improvements based on Gonçalo's audit, as requested by João. Highest-value static wins with no new npm dependencies, no unrelated churn, and no conflict with #30 (already merged).


Architecture findings (pre-PR)

ConcernFinding
Routing modehistory: "hash" — all docs URLs are #/docs/…
Hosting fallbackpublic/.htaccess already rewrites all paths → index.html
Static file servingVite copies public/ verbatim to dist/
Existing metadataindex.html had generic OG/Twitter tags but no canonical, no JSON-LD, no robots.txt, no sitemap, no per-page titles
PR #30Merged before this PR — docs/skills route is live ✓
Hash URL + canonicalsHash fragments are not real URLs → single canonical at root is correct; per-page canonicals add no benefit without SSR
Clean URL migrationDeferred — server must be verified to support try_files / Apache rewrite for every /docs/* path; .htaccess is present but hosting needs confirmation

Changes

FileWhat
public/robots.txtAllow all crawlers; Sitemap: directive pointing to sitemap
public/sitemap.xml29 <url> entries for every registered route (home, all docs pages, playground)
public/llms.txtllmstxt.org convention — machine-readable site manifest for LLM indexers (GPTBot, Claude, Gemini)
index.html<link rel="canonical"> → root URL; two JSON-LD blocks (WebSite + SoftwareApplication); improved title/description copy ("zero-HTML" framing)
src/utils/seo.tsNewupdatePageMeta(pathname) with per-route <title> + <meta name="description"> map (29 routes)
src/views/elements/Base.tsCall updatePageMeta(Router.pathname) in BaseView constructor — fires on every docs page navigation

What was deferred / not included

ItemReason
Clean (history-mode) URLsRequires confirming hosting supports path rewrites for all/docs/* URLs before enabling history: "browser" in the router — wrong call without server verification; the .htaccess is present but needs testing
Per-page canonical URLsNo benefit over root canonical with hash routing + no SSR
Prerendering / static HTMLOut of scope — would require either SSR or a prerender plugin

Validation

npm install
npm run build # ✓ built in 11.11s — zero errors, zero new warnings

Build confirms all 3 static files are copied to dist/ (robots.txt, sitemap.xml, llms.txt), index.html contains canonical and JSON-LD, and seo.ts is tree-shaken cleanly into the bundle.

Diff: 6 files — 430 insertions, 9 deletions (index.html copy improvements).

Reviewer

@zico15

… per-page meta
P0/P1 indexability improvements based on Gonçalo's audit:
- public/robots.txt — allow all crawlers, point to sitemap
- public/sitemap.xml — 29 URL entries covering all docs routes + home + playground
- public/llms.txt — LLM-friendly site manifest (llmstxt.org convention)
- index.html — canonical <link> pointing to https://typecomposer.com/;
two JSON-LD blocks (WebSite + SoftwareApplication);
improved global title/description ('zero-HTML' framing)
- src/utils/seo.ts — updatePageMeta() utility: per-route <title> and
<meta name=description> map (29 routes); called on each
route activation so browser history and JS-rendered tabs
show meaningful page titles
- src/views/elements/Base.ts — call updatePageMeta(Router.pathname) in BaseView
constructor so every docs page updates the document title
Hash routing constraint: canonical stays fixed at the root URL since hash
fragments are not real URLs (no per-page canonical benefit without SSR).
Clean URL migration deferred — requires hosting config validation.
Build: vite build ✓ 11.11s, 0 errors
Resolves: robots.txt missing, no sitemap, no per-page titles/descriptions
@joaodibba
joaodibba merged commit f104878 into TypeComposer:mainJun 12, 2026
1 check failed
joaodibba pushed a commit that referenced this pull request Jun 12, 2026
… URLs
SEO P0 follow-up to PRs #29#31.
Problem: hash routing (/#/docs/skills) is not indexable by search engines
because the fragment is never sent to the server. Direct deep-links also 404
without a server-side SPA fallback.
Changes:
- src/router/router.ts: history: "hash" → history: "browser" — enables clean
URLs like /docs/skills, /docs/getting-started, /playground
- vite.config.js: base: "./" → base: "/" — absolute asset paths prevent
broken asset loads when navigating to nested routes (e.g. /docs/skills)
- public/.htaccess: improve comments; SPA fallback rule was already correct
(rewrite all non-file/non-dir requests to /index.html) and remains unchanged
in logic — confirmed present before this PR
- src/utils/seo.ts: add per-route canonical <link> injection (setCanonical);
now meaningful because each route has a real URL; updated Router description
to remove "hash" reference; root canonical in index.html stays https://typecomposer.com/
- public/sitemap.xml: strip /#/ from all 29 URLs (e.g. /#/docs/skills →
/docs/skills, /#/playground → /playground)
- public/llms.txt: strip /#/ from all 29 doc links; update Router key concept
description to reference browser history mode
- index.html: update JSON-LD SearchAction target from /#/docs/… to /docs/…
Hosting note (⚠ must verify after deploy):
The .htaccess SPA fallback was already present in the repo (added before PR #31)
and is confirmed to contain the correct RewriteRule. Direct deep-link indexability
(e.g. https://typecomposer.com/docs/skills returning 200 not 404) requires the
Apache server to honour this .htaccess. Test with:
curl -I https://typecomposer.com/docs/skills
Expected: HTTP/2 200, not 301/302/404.
Build: npm run build — ✓ 2405 modules, no errors
Reviewer: @zico15
joaodibba added a commit that referenced this pull request Jun 12, 2026
…e URLs (#32)
## SEO P0 — Clean URLs via Browser History Routing
Follow-up to #29, #30, #31.
### Problem
Hash routing (`/#/docs/skills`) is not indexable by search engines — the
fragment after `#` is never sent to the server, so Googlebot sees only
`https://typecomposer.com/` for every page. Direct deep-links to
`/docs/skills` also 404 without a proper SPA fallback. This means the
sitemap, per-route canonicals, and per-page meta added in #31 cannot
deliver their full SEO value.
### Solution
Switch `Router.create` from `history: "hash"` to `history: "browser"`
(HTML5 `pushState`). The server-side SPA fallback (`.htaccess`) was
**already present in the repo** before this PR and contains the correct
`RewriteRule ^.*$ /index.html [L,QSA]` — so direct deep-links will be
served correctly on the Apache-hosted production site once this PR is
merged and deployed.
---
### Files Changed (7)
| File | Change |
|------|--------|
| `src/router/router.ts` | `history: "hash"` → `history: "browser"` |
| `vite.config.js` | `base: "./"` → `base: "/"` — absolute asset paths
prevent broken JS/CSS loads when a user navigates directly to a nested
route like `/docs/skills` (relative `./assets/` would resolve to
`/docs/assets/`) |
| `src/utils/seo.ts` | `updatePageMeta()` updates `<title>` and `<meta
name="description">` per route. Runtime `setCanonical()` workaround
**removed** — the static root canonical in `index.html` covers the home
route, and `sitemap.xml` provides authoritative clean-URL canonicals for
all 29 pages without requiring JS. |
| `public/sitemap.xml` | Strip `#/` from all 29 URLs (`/#/docs/skills` →
`/docs/skills`, `/#/playground` → `/playground`) |
| `public/llms.txt` | Same URL migration for all 29 doc links; Router
key concept updated to reference `history: "browser"` |
| `index.html` | JSON-LD `SearchAction.target` updated from
`/#/docs/{search_term_string}` → `/docs/{search_term_string}`; canonical
comment tidied |
| `public/.htaccess` | Comments improved for clarity; **rewrite rule
logic unchanged** — it was already correct |
---
### Build Validation (commit 2)
```
npm run build
✓ 2405 modules transformed — no errors, no type errors
```
```
dist/.htaccess ✓ present (copied from public/)
dist/sitemap.xml ✓ 0 hash URLs remaining
dist/llms.txt ✓ 0 hash URLs remaining
dist/index.html ✓ assets load from /assets/* (absolute paths)
dist/index.html ✓ root canonical <https://typecomposer.com/> present
src/utils/seo.ts ✓ setCanonical() removed
src/utils/seo.ts ✓ CANONICAL_BASE constant removed
```
---
### ⚠️ Hosting Verification Required Before Release
The `.htaccess` SPA fallback must be honoured by the production Apache
server. Please test after deploy:
```bash
# Direct deep-link must return HTTP 200, not 301/302/404
curl -I https://typecomposer.com/docs/skills
# Expected: HTTP/2 200
curl -I https://typecomposer.com/docs/getting-started
# Expected: HTTP/2 200
curl -I https://typecomposer.com/playground
# Expected: HTTP/2 200
# Assets must still load correctly
curl -I https://typecomposer.com/typecomposer.svg
# Expected: HTTP/2 200
curl -I https://typecomposer.com/sitemap.xml
# Expected: HTTP/2 200
```
If the Apache server requires `AllowOverride All` in its vhost config,
that must be enabled separately by the hosting admin. If `.htaccess` is
not supported, a `_redirects` (Netlify) or `vercel.json` equivalent
would be needed — but the existing `.htaccess` confirms Apache is the
target host.
---
### /docs/skills → Agent Skills ✓
Route `docs/skills` maps to `BaseView` and `PAGE_META["docs/skills"]` is
unchanged:
- Title: **Agent Skills | TypeComposer**
- Description: _Use TypeComposer to build AI agent skills…_
---
cc @zico15
zico15 added a commit that referenced this pull request Jun 12, 2026
…d-wasm and component registration (#33)
## Summary
Finishes and unblocks PR #15 (originally opened by @Copilot, which had 4
merge conflicts with `main`).
This branch is identical to the Copilot PR branch but with a merge
commit that resolves all 4 conflicts against current `main`.
---
## What this PR does
Migrates `PlaygroundView` from `@codesandbox/sandpack-client` (remote
compilation) to **fully browser-based compilation** using
`esbuild-wasm`, satisfying all acceptance criteria from issue #14.
### Changes
| File | Change |
|---|---|
| `src/utils/browserCompiler.ts` (**new**) | esbuild-wasm in-browser TS
compiler with virtual file system plugin |
| `src/components/editor/MonacoEditor.ts` (**new**) | Monaco Editor
wrapped as a TypeComposer `Component` |
| `src/views/playground/PlaygroundView.ts` | Replaced
`loadSandpackClient` with `compileAndRun()`, iframe injection via blob
URL + import map, Monaco split-view |
| `src/styles/` | Refactored `src/style.scss` → `src/styles/index.css` +
`src/styles/style.scss` (Tailwind v4) |
| `package.json` | Removed `@codesandbox/sandpack-client`; added
`esbuild-wasm ^0.25.10`, `monaco-editor ^0.54.0`, `@monaco-editor/loader
^1.5.0`, Tailwind v4 + `@tailwindcss/vite`; moved `typecomposer-plugin`
to `devDependencies`; bumped `typecomposer` to `^0.1.56` |
| `vite.config.ts` | Renamed from `.js`, added `tailwindcss()` plugin,
`base: "/"` (browser-history routing), scss preprocessor config |
### TypeComposer Component Registration
TypeComposer components (`DivElement`, `VBox`, `HBox`, etc.) are Web
Components that must be registered via `customElements.define()` before
instantiation. The playground injects an import map pointing
`typecomposer` at `esm.sh/typecomposer`, which makes the CDN-loaded
classes available to user code. `typecomposer` is marked `external` in
esbuild so imports pass through to the import map.
### Merge Conflict Resolution (vs PR #15)
The original Copilot branch diverged from `main` after `main` received
SEO/routing commits (#31, #32). This PR adds one merge commit that:
1. Bumps `typecomposer` `^0.1.54` → `^0.1.56` 2. Moves `typecomposer-plugin` to `devDependencies`
3. Fixes `vite.config.ts` `base: "./"` → `base: "/"` (required for
browser-history routing from main)
4. Adds `scss: { api: "modern-compiler" }` preprocessor config from main
5. Regenerates `package-lock.json`
---
## Build result
```
✓ 3452 modules transformed.
✓ built in 15.16s
```
---
## Acceptance criteria checklist
- [x] Remove `loadSandpackClient` and `bundlerURL` dependency
- [x] Integrate `esbuild-wasm` to compile TypeScript in the browser
- [x] Preserve `files` object / multi-file compilation
- [x] `IFrameElement` executes compiled JS via blob URL in sandboxed
iframe
- [x] Compilation and runtime errors displayed clearly
- [x] Current layout/styles maintained
- [x] TypeComposer Web Components registered before user code runs
(import map + CDN)
Closes#14
Supersedes #15 (conflict-free replacement)
cc @zico15@joaodibba
Sign up for freeto 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

@lucas-spin@joaodibba
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(seo): robots.txt, sitemap.xml, llms.txt, canonical URL, JSON-LD, per-page meta titles/descriptions - #31

Merged
joaodibba merged 1 commit into
TypeComposer:mainfrom
lucas-spin:feat/seo-indexability
Jun 12, 2026
Merged

feat(seo): robots.txt, sitemap.xml, llms.txt, canonical URL, JSON-LD, per-page meta titles/descriptions#31
joaodibba merged 1 commit into
TypeComposer:mainfrom
lucas-spin:feat/seo-indexability

Conversation

@lucas-spin

Copy link
Copy Markdown
Contributor

What changed and why

SEO/indexability improvements based on Gonçalo's audit, as requested by João. Highest-value static wins with no new npm dependencies, no unrelated churn, and no conflict with #30 (already merged).


Architecture findings (pre-PR)

ConcernFinding
Routing modehistory: "hash" — all docs URLs are #/docs/…
Hosting fallbackpublic/.htaccess already rewrites all paths → index.html
Static file servingVite copies public/ verbatim to dist/
Existing metadataindex.html had generic OG/Twitter tags but no canonical, no JSON-LD, no robots.txt, no sitemap, no per-page titles
PR #30Merged before this PR — docs/skills route is live ✓
Hash URL + canonicalsHash fragments are not real URLs → single canonical at root is correct; per-page canonicals add no benefit without SSR
Clean URL migrationDeferred — server must be verified to support try_files / Apache rewrite for every /docs/* path; .htaccess is present but hosting needs confirmation

Changes

FileWhat
public/robots.txtAllow all crawlers; Sitemap: directive pointing to sitemap
public/sitemap.xml29 <url> entries for every registered route (home, all docs pages, playground)
public/llms.txtllmstxt.org convention — machine-readable site manifest for LLM indexers (GPTBot, Claude, Gemini)
index.html<link rel="canonical"> → root URL; two JSON-LD blocks (WebSite + SoftwareApplication); improved title/description copy ("zero-HTML" framing)
src/utils/seo.tsNewupdatePageMeta(pathname) with per-route <title> + <meta name="description"> map (29 routes)
src/views/elements/Base.tsCall updatePageMeta(Router.pathname) in BaseView constructor — fires on every docs page navigation

What was deferred / not included

ItemReason
Clean (history-mode) URLsRequires confirming hosting supports path rewrites for all/docs/* URLs before enabling history: "browser" in the router — wrong call without server verification; the .htaccess is present but needs testing
Per-page canonical URLsNo benefit over root canonical with hash routing + no SSR
Prerendering / static HTMLOut of scope — would require either SSR or a prerender plugin

Validation

npm install
npm run build # ✓ built in 11.11s — zero errors, zero new warnings

Build confirms all 3 static files are copied to dist/ (robots.txt, sitemap.xml, llms.txt), index.html contains canonical and JSON-LD, and seo.ts is tree-shaken cleanly into the bundle.

Diff: 6 files — 430 insertions, 9 deletions (index.html copy improvements).

Reviewer

@zico15

… per-page meta
P0/P1 indexability improvements based on Gonçalo's audit:
- public/robots.txt — allow all crawlers, point to sitemap
- public/sitemap.xml — 29 URL entries covering all docs routes + home + playground
- public/llms.txt — LLM-friendly site manifest (llmstxt.org convention)
- index.html — canonical <link> pointing to https://typecomposer.com/;
two JSON-LD blocks (WebSite + SoftwareApplication);
improved global title/description ('zero-HTML' framing)
- src/utils/seo.ts — updatePageMeta() utility: per-route <title> and
<meta name=description> map (29 routes); called on each
route activation so browser history and JS-rendered tabs
show meaningful page titles
- src/views/elements/Base.ts — call updatePageMeta(Router.pathname) in BaseView
constructor so every docs page updates the document title
Hash routing constraint: canonical stays fixed at the root URL since hash
fragments are not real URLs (no per-page canonical benefit without SSR).
Clean URL migration deferred — requires hosting config validation.
Build: vite build ✓ 11.11s, 0 errors
Resolves: robots.txt missing, no sitemap, no per-page titles/descriptions
@joaodibba
joaodibba merged commit f104878 into TypeComposer:mainJun 12, 2026
1 check failed
joaodibba pushed a commit that referenced this pull request Jun 12, 2026
… URLs
SEO P0 follow-up to PRs #29#31.
Problem: hash routing (/#/docs/skills) is not indexable by search engines
because the fragment is never sent to the server. Direct deep-links also 404
without a server-side SPA fallback.
Changes:
- src/router/router.ts: history: "hash" → history: "browser" — enables clean
URLs like /docs/skills, /docs/getting-started, /playground
- vite.config.js: base: "./" → base: "/" — absolute asset paths prevent
broken asset loads when navigating to nested routes (e.g. /docs/skills)
- public/.htaccess: improve comments; SPA fallback rule was already correct
(rewrite all non-file/non-dir requests to /index.html) and remains unchanged
in logic — confirmed present before this PR
- src/utils/seo.ts: add per-route canonical <link> injection (setCanonical);
now meaningful because each route has a real URL; updated Router description
to remove "hash" reference; root canonical in index.html stays https://typecomposer.com/
- public/sitemap.xml: strip /#/ from all 29 URLs (e.g. /#/docs/skills →
/docs/skills, /#/playground → /playground)
- public/llms.txt: strip /#/ from all 29 doc links; update Router key concept
description to reference browser history mode
- index.html: update JSON-LD SearchAction target from /#/docs/… to /docs/…
Hosting note (⚠ must verify after deploy):
The .htaccess SPA fallback was already present in the repo (added before PR #31)
and is confirmed to contain the correct RewriteRule. Direct deep-link indexability
(e.g. https://typecomposer.com/docs/skills returning 200 not 404) requires the
Apache server to honour this .htaccess. Test with:
curl -I https://typecomposer.com/docs/skills
Expected: HTTP/2 200, not 301/302/404.
Build: npm run build — ✓ 2405 modules, no errors
Reviewer: @zico15
joaodibba added a commit that referenced this pull request Jun 12, 2026
…e URLs (#32)
## SEO P0 — Clean URLs via Browser History Routing
Follow-up to #29, #30, #31.
### Problem
Hash routing (`/#/docs/skills`) is not indexable by search engines — the
fragment after `#` is never sent to the server, so Googlebot sees only
`https://typecomposer.com/` for every page. Direct deep-links to
`/docs/skills` also 404 without a proper SPA fallback. This means the
sitemap, per-route canonicals, and per-page meta added in #31 cannot
deliver their full SEO value.
### Solution
Switch `Router.create` from `history: "hash"` to `history: "browser"`
(HTML5 `pushState`). The server-side SPA fallback (`.htaccess`) was
**already present in the repo** before this PR and contains the correct
`RewriteRule ^.*$ /index.html [L,QSA]` — so direct deep-links will be
served correctly on the Apache-hosted production site once this PR is
merged and deployed.
---
### Files Changed (7)
| File | Change |
|------|--------|
| `src/router/router.ts` | `history: "hash"` → `history: "browser"` |
| `vite.config.js` | `base: "./"` → `base: "/"` — absolute asset paths
prevent broken JS/CSS loads when a user navigates directly to a nested
route like `/docs/skills` (relative `./assets/` would resolve to
`/docs/assets/`) |
| `src/utils/seo.ts` | `updatePageMeta()` updates `<title>` and `<meta
name="description">` per route. Runtime `setCanonical()` workaround
**removed** — the static root canonical in `index.html` covers the home
route, and `sitemap.xml` provides authoritative clean-URL canonicals for
all 29 pages without requiring JS. |
| `public/sitemap.xml` | Strip `#/` from all 29 URLs (`/#/docs/skills` →
`/docs/skills`, `/#/playground` → `/playground`) |
| `public/llms.txt` | Same URL migration for all 29 doc links; Router
key concept updated to reference `history: "browser"` |
| `index.html` | JSON-LD `SearchAction.target` updated from
`/#/docs/{search_term_string}` → `/docs/{search_term_string}`; canonical
comment tidied |
| `public/.htaccess` | Comments improved for clarity; **rewrite rule
logic unchanged** — it was already correct |
---
### Build Validation (commit 2)
```
npm run build
✓ 2405 modules transformed — no errors, no type errors
```
```
dist/.htaccess ✓ present (copied from public/)
dist/sitemap.xml ✓ 0 hash URLs remaining
dist/llms.txt ✓ 0 hash URLs remaining
dist/index.html ✓ assets load from /assets/* (absolute paths)
dist/index.html ✓ root canonical <https://typecomposer.com/> present
src/utils/seo.ts ✓ setCanonical() removed
src/utils/seo.ts ✓ CANONICAL_BASE constant removed
```
---
### ⚠️ Hosting Verification Required Before Release
The `.htaccess` SPA fallback must be honoured by the production Apache
server. Please test after deploy:
```bash
# Direct deep-link must return HTTP 200, not 301/302/404
curl -I https://typecomposer.com/docs/skills
# Expected: HTTP/2 200
curl -I https://typecomposer.com/docs/getting-started
# Expected: HTTP/2 200
curl -I https://typecomposer.com/playground
# Expected: HTTP/2 200
# Assets must still load correctly
curl -I https://typecomposer.com/typecomposer.svg
# Expected: HTTP/2 200
curl -I https://typecomposer.com/sitemap.xml
# Expected: HTTP/2 200
```
If the Apache server requires `AllowOverride All` in its vhost config,
that must be enabled separately by the hosting admin. If `.htaccess` is
not supported, a `_redirects` (Netlify) or `vercel.json` equivalent
would be needed — but the existing `.htaccess` confirms Apache is the
target host.
---
### /docs/skills → Agent Skills ✓
Route `docs/skills` maps to `BaseView` and `PAGE_META["docs/skills"]` is
unchanged:
- Title: **Agent Skills | TypeComposer**
- Description: _Use TypeComposer to build AI agent skills…_
---
cc @zico15
zico15 added a commit that referenced this pull request Jun 12, 2026
…d-wasm and component registration (#33)
## Summary
Finishes and unblocks PR #15 (originally opened by @Copilot, which had 4
merge conflicts with `main`).
This branch is identical to the Copilot PR branch but with a merge
commit that resolves all 4 conflicts against current `main`.
---
## What this PR does
Migrates `PlaygroundView` from `@codesandbox/sandpack-client` (remote
compilation) to **fully browser-based compilation** using
`esbuild-wasm`, satisfying all acceptance criteria from issue #14.
### Changes
| File | Change |
|---|---|
| `src/utils/browserCompiler.ts` (**new**) | esbuild-wasm in-browser TS
compiler with virtual file system plugin |
| `src/components/editor/MonacoEditor.ts` (**new**) | Monaco Editor
wrapped as a TypeComposer `Component` |
| `src/views/playground/PlaygroundView.ts` | Replaced
`loadSandpackClient` with `compileAndRun()`, iframe injection via blob
URL + import map, Monaco split-view |
| `src/styles/` | Refactored `src/style.scss` → `src/styles/index.css` +
`src/styles/style.scss` (Tailwind v4) |
| `package.json` | Removed `@codesandbox/sandpack-client`; added
`esbuild-wasm ^0.25.10`, `monaco-editor ^0.54.0`, `@monaco-editor/loader
^1.5.0`, Tailwind v4 + `@tailwindcss/vite`; moved `typecomposer-plugin`
to `devDependencies`; bumped `typecomposer` to `^0.1.56` |
| `vite.config.ts` | Renamed from `.js`, added `tailwindcss()` plugin,
`base: "/"` (browser-history routing), scss preprocessor config |
### TypeComposer Component Registration
TypeComposer components (`DivElement`, `VBox`, `HBox`, etc.) are Web
Components that must be registered via `customElements.define()` before
instantiation. The playground injects an import map pointing
`typecomposer` at `esm.sh/typecomposer`, which makes the CDN-loaded
classes available to user code. `typecomposer` is marked `external` in
esbuild so imports pass through to the import map.
### Merge Conflict Resolution (vs PR #15)
The original Copilot branch diverged from `main` after `main` received
SEO/routing commits (#31, #32). This PR adds one merge commit that:
1. Bumps `typecomposer` `^0.1.54` → `^0.1.56` 2. Moves `typecomposer-plugin` to `devDependencies`
3. Fixes `vite.config.ts` `base: "./"` → `base: "/"` (required for
browser-history routing from main)
4. Adds `scss: { api: "modern-compiler" }` preprocessor config from main
5. Regenerates `package-lock.json`
---
## Build result
```
✓ 3452 modules transformed.
✓ built in 15.16s
```
---
## Acceptance criteria checklist
- [x] Remove `loadSandpackClient` and `bundlerURL` dependency
- [x] Integrate `esbuild-wasm` to compile TypeScript in the browser
- [x] Preserve `files` object / multi-file compilation
- [x] `IFrameElement` executes compiled JS via blob URL in sandboxed
iframe
- [x] Compilation and runtime errors displayed clearly
- [x] Current layout/styles maintained
- [x] TypeComposer Web Components registered before user code runs
(import map + CDN)
Closes#14
Supersedes #15 (conflict-free replacement)
cc @zico15@joaodibba
Sign up for freeto 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

@lucas-spin@joaodibba
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

feat(seo): robots.txt, sitemap.xml, llms.txt, canonical URL, JSON-LD, per-page meta titles/descriptions - #31

Merged
joaodibba merged 1 commit into
TypeComposer:mainfrom
lucas-spin:feat/seo-indexability
Jun 12, 2026
Merged

feat(seo): robots.txt, sitemap.xml, llms.txt, canonical URL, JSON-LD, per-page meta titles/descriptions#31
joaodibba merged 1 commit into
TypeComposer:mainfrom
lucas-spin:feat/seo-indexability

Conversation

@lucas-spin

Copy link
Copy Markdown
Contributor

What changed and why

SEO/indexability improvements based on Gonçalo's audit, as requested by João. Highest-value static wins with no new npm dependencies, no unrelated churn, and no conflict with #30 (already merged).


Architecture findings (pre-PR)

ConcernFinding
Routing modehistory: "hash" — all docs URLs are #/docs/…
Hosting fallbackpublic/.htaccess already rewrites all paths → index.html
Static file servingVite copies public/ verbatim to dist/
Existing metadataindex.html had generic OG/Twitter tags but no canonical, no JSON-LD, no robots.txt, no sitemap, no per-page titles
PR #30Merged before this PR — docs/skills route is live ✓
Hash URL + canonicalsHash fragments are not real URLs → single canonical at root is correct; per-page canonicals add no benefit without SSR
Clean URL migrationDeferred — server must be verified to support try_files / Apache rewrite for every /docs/* path; .htaccess is present but hosting needs confirmation

Changes

FileWhat
public/robots.txtAllow all crawlers; Sitemap: directive pointing to sitemap
public/sitemap.xml29 <url> entries for every registered route (home, all docs pages, playground)
public/llms.txtllmstxt.org convention — machine-readable site manifest for LLM indexers (GPTBot, Claude, Gemini)
index.html<link rel="canonical"> → root URL; two JSON-LD blocks (WebSite + SoftwareApplication); improved title/description copy ("zero-HTML" framing)
src/utils/seo.tsNewupdatePageMeta(pathname) with per-route <title> + <meta name="description"> map (29 routes)
src/views/elements/Base.tsCall updatePageMeta(Router.pathname) in BaseView constructor — fires on every docs page navigation

What was deferred / not included

ItemReason
Clean (history-mode) URLsRequires confirming hosting supports path rewrites for all/docs/* URLs before enabling history: "browser" in the router — wrong call without server verification; the .htaccess is present but needs testing
Per-page canonical URLsNo benefit over root canonical with hash routing + no SSR
Prerendering / static HTMLOut of scope — would require either SSR or a prerender plugin

Validation

npm install
npm run build # ✓ built in 11.11s — zero errors, zero new warnings

Build confirms all 3 static files are copied to dist/ (robots.txt, sitemap.xml, llms.txt), index.html contains canonical and JSON-LD, and seo.ts is tree-shaken cleanly into the bundle.

Diff: 6 files — 430 insertions, 9 deletions (index.html copy improvements).

Reviewer

@zico15

… per-page meta
P0/P1 indexability improvements based on Gonçalo's audit:
- public/robots.txt — allow all crawlers, point to sitemap
- public/sitemap.xml — 29 URL entries covering all docs routes + home + playground
- public/llms.txt — LLM-friendly site manifest (llmstxt.org convention)
- index.html — canonical <link> pointing to https://typecomposer.com/;
two JSON-LD blocks (WebSite + SoftwareApplication);
improved global title/description ('zero-HTML' framing)
- src/utils/seo.ts — updatePageMeta() utility: per-route <title> and
<meta name=description> map (29 routes); called on each
route activation so browser history and JS-rendered tabs
show meaningful page titles
- src/views/elements/Base.ts — call updatePageMeta(Router.pathname) in BaseView
constructor so every docs page updates the document title
Hash routing constraint: canonical stays fixed at the root URL since hash
fragments are not real URLs (no per-page canonical benefit without SSR).
Clean URL migration deferred — requires hosting config validation.
Build: vite build ✓ 11.11s, 0 errors
Resolves: robots.txt missing, no sitemap, no per-page titles/descriptions
@joaodibba
joaodibba merged commit f104878 into TypeComposer:mainJun 12, 2026
1 check failed
joaodibba pushed a commit that referenced this pull request Jun 12, 2026
… URLs
SEO P0 follow-up to PRs #29#31.
Problem: hash routing (/#/docs/skills) is not indexable by search engines
because the fragment is never sent to the server. Direct deep-links also 404
without a server-side SPA fallback.
Changes:
- src/router/router.ts: history: "hash" → history: "browser" — enables clean
URLs like /docs/skills, /docs/getting-started, /playground
- vite.config.js: base: "./" → base: "/" — absolute asset paths prevent
broken asset loads when navigating to nested routes (e.g. /docs/skills)
- public/.htaccess: improve comments; SPA fallback rule was already correct
(rewrite all non-file/non-dir requests to /index.html) and remains unchanged
in logic — confirmed present before this PR
- src/utils/seo.ts: add per-route canonical <link> injection (setCanonical);
now meaningful because each route has a real URL; updated Router description
to remove "hash" reference; root canonical in index.html stays https://typecomposer.com/
- public/sitemap.xml: strip /#/ from all 29 URLs (e.g. /#/docs/skills →
/docs/skills, /#/playground → /playground)
- public/llms.txt: strip /#/ from all 29 doc links; update Router key concept
description to reference browser history mode
- index.html: update JSON-LD SearchAction target from /#/docs/… to /docs/…
Hosting note (⚠ must verify after deploy):
The .htaccess SPA fallback was already present in the repo (added before PR #31)
and is confirmed to contain the correct RewriteRule. Direct deep-link indexability
(e.g. https://typecomposer.com/docs/skills returning 200 not 404) requires the
Apache server to honour this .htaccess. Test with:
curl -I https://typecomposer.com/docs/skills
Expected: HTTP/2 200, not 301/302/404.
Build: npm run build — ✓ 2405 modules, no errors
Reviewer: @zico15
joaodibba added a commit that referenced this pull request Jun 12, 2026
…e URLs (#32)
## SEO P0 — Clean URLs via Browser History Routing
Follow-up to #29, #30, #31.
### Problem
Hash routing (`/#/docs/skills`) is not indexable by search engines — the
fragment after `#` is never sent to the server, so Googlebot sees only
`https://typecomposer.com/` for every page. Direct deep-links to
`/docs/skills` also 404 without a proper SPA fallback. This means the
sitemap, per-route canonicals, and per-page meta added in #31 cannot
deliver their full SEO value.
### Solution
Switch `Router.create` from `history: "hash"` to `history: "browser"`
(HTML5 `pushState`). The server-side SPA fallback (`.htaccess`) was
**already present in the repo** before this PR and contains the correct
`RewriteRule ^.*$ /index.html [L,QSA]` — so direct deep-links will be
served correctly on the Apache-hosted production site once this PR is
merged and deployed.
---
### Files Changed (7)
| File | Change |
|------|--------|
| `src/router/router.ts` | `history: "hash"` → `history: "browser"` |
| `vite.config.js` | `base: "./"` → `base: "/"` — absolute asset paths
prevent broken JS/CSS loads when a user navigates directly to a nested
route like `/docs/skills` (relative `./assets/` would resolve to
`/docs/assets/`) |
| `src/utils/seo.ts` | `updatePageMeta()` updates `<title>` and `<meta
name="description">` per route. Runtime `setCanonical()` workaround
**removed** — the static root canonical in `index.html` covers the home
route, and `sitemap.xml` provides authoritative clean-URL canonicals for
all 29 pages without requiring JS. |
| `public/sitemap.xml` | Strip `#/` from all 29 URLs (`/#/docs/skills` →
`/docs/skills`, `/#/playground` → `/playground`) |
| `public/llms.txt` | Same URL migration for all 29 doc links; Router
key concept updated to reference `history: "browser"` |
| `index.html` | JSON-LD `SearchAction.target` updated from
`/#/docs/{search_term_string}` → `/docs/{search_term_string}`; canonical
comment tidied |
| `public/.htaccess` | Comments improved for clarity; **rewrite rule
logic unchanged** — it was already correct |
---
### Build Validation (commit 2)
```
npm run build
✓ 2405 modules transformed — no errors, no type errors
```
```
dist/.htaccess ✓ present (copied from public/)
dist/sitemap.xml ✓ 0 hash URLs remaining
dist/llms.txt ✓ 0 hash URLs remaining
dist/index.html ✓ assets load from /assets/* (absolute paths)
dist/index.html ✓ root canonical <https://typecomposer.com/> present
src/utils/seo.ts ✓ setCanonical() removed
src/utils/seo.ts ✓ CANONICAL_BASE constant removed
```
---
### ⚠️ Hosting Verification Required Before Release
The `.htaccess` SPA fallback must be honoured by the production Apache
server. Please test after deploy:
```bash
# Direct deep-link must return HTTP 200, not 301/302/404
curl -I https://typecomposer.com/docs/skills
# Expected: HTTP/2 200
curl -I https://typecomposer.com/docs/getting-started
# Expected: HTTP/2 200
curl -I https://typecomposer.com/playground
# Expected: HTTP/2 200
# Assets must still load correctly
curl -I https://typecomposer.com/typecomposer.svg
# Expected: HTTP/2 200
curl -I https://typecomposer.com/sitemap.xml
# Expected: HTTP/2 200
```
If the Apache server requires `AllowOverride All` in its vhost config,
that must be enabled separately by the hosting admin. If `.htaccess` is
not supported, a `_redirects` (Netlify) or `vercel.json` equivalent
would be needed — but the existing `.htaccess` confirms Apache is the
target host.
---
### /docs/skills → Agent Skills ✓
Route `docs/skills` maps to `BaseView` and `PAGE_META["docs/skills"]` is
unchanged:
- Title: **Agent Skills | TypeComposer**
- Description: _Use TypeComposer to build AI agent skills…_
---
cc @zico15
zico15 added a commit that referenced this pull request Jun 12, 2026
…d-wasm and component registration (#33)
## Summary
Finishes and unblocks PR #15 (originally opened by @Copilot, which had 4
merge conflicts with `main`).
This branch is identical to the Copilot PR branch but with a merge
commit that resolves all 4 conflicts against current `main`.
---
## What this PR does
Migrates `PlaygroundView` from `@codesandbox/sandpack-client` (remote
compilation) to **fully browser-based compilation** using
`esbuild-wasm`, satisfying all acceptance criteria from issue #14.
### Changes
| File | Change |
|---|---|
| `src/utils/browserCompiler.ts` (**new**) | esbuild-wasm in-browser TS
compiler with virtual file system plugin |
| `src/components/editor/MonacoEditor.ts` (**new**) | Monaco Editor
wrapped as a TypeComposer `Component` |
| `src/views/playground/PlaygroundView.ts` | Replaced
`loadSandpackClient` with `compileAndRun()`, iframe injection via blob
URL + import map, Monaco split-view |
| `src/styles/` | Refactored `src/style.scss` → `src/styles/index.css` +
`src/styles/style.scss` (Tailwind v4) |
| `package.json` | Removed `@codesandbox/sandpack-client`; added
`esbuild-wasm ^0.25.10`, `monaco-editor ^0.54.0`, `@monaco-editor/loader
^1.5.0`, Tailwind v4 + `@tailwindcss/vite`; moved `typecomposer-plugin`
to `devDependencies`; bumped `typecomposer` to `^0.1.56` |
| `vite.config.ts` | Renamed from `.js`, added `tailwindcss()` plugin,
`base: "/"` (browser-history routing), scss preprocessor config |
### TypeComposer Component Registration
TypeComposer components (`DivElement`, `VBox`, `HBox`, etc.) are Web
Components that must be registered via `customElements.define()` before
instantiation. The playground injects an import map pointing
`typecomposer` at `esm.sh/typecomposer`, which makes the CDN-loaded
classes available to user code. `typecomposer` is marked `external` in
esbuild so imports pass through to the import map.
### Merge Conflict Resolution (vs PR #15)
The original Copilot branch diverged from `main` after `main` received
SEO/routing commits (#31, #32). This PR adds one merge commit that:
1. Bumps `typecomposer` `^0.1.54` → `^0.1.56` 2. Moves `typecomposer-plugin` to `devDependencies`
3. Fixes `vite.config.ts` `base: "./"` → `base: "/"` (required for
browser-history routing from main)
4. Adds `scss: { api: "modern-compiler" }` preprocessor config from main
5. Regenerates `package-lock.json`
---
## Build result
```
✓ 3452 modules transformed.
✓ built in 15.16s
```
---
## Acceptance criteria checklist
- [x] Remove `loadSandpackClient` and `bundlerURL` dependency
- [x] Integrate `esbuild-wasm` to compile TypeScript in the browser
- [x] Preserve `files` object / multi-file compilation
- [x] `IFrameElement` executes compiled JS via blob URL in sandboxed
iframe
- [x] Compilation and runtime errors displayed clearly
- [x] Current layout/styles maintained
- [x] TypeComposer Web Components registered before user code runs
(import map + CDN)
Closes#14
Supersedes #15 (conflict-free replacement)
cc @zico15@joaodibba
Sign up for freeto 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

@lucas-spin@joaodibba