Skip to content

Commit bea99ef

Browse files
Addressing Alain's feedback
1 parent beff720 commit bea99ef

9 files changed

Lines changed: 45 additions & 23 deletions

File tree

docs/abca-plugin/skills/setup/SKILL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,4 +96,4 @@ Guide through:
9696
After all phases pass, summarize:
9797
- Stack outputs (API URL, User Pool ID, etc.)
9898
- Next steps: onboard a repository (use the `onboard-repo` skill)
99-
- Point to the User Guide: https://aws-samples.github.io/sample-autonomous-cloud-coding-agents/user-guide/introduction/
99+
- Point to the Quick Start: https://aws-samples.github.io/sample-autonomous-cloud-coding-agents/getting-started/quick-start/

docs/astro.config.mjs

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/plugins/remark-mermaid.mjs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
11
import { visit } from 'unist-util-visit';
22

3+
function escapeHtml(str) {
4+
return str.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;');
5+
}
6+
37
export function remarkMermaid() {
48
return (tree) => {
59
visit(tree, 'code', (node, index, parent) => {
610
if (node.lang !== 'mermaid' || !parent) return;
711
parent.children[index] = {
812
type: 'html',
9-
value: `<pre class="mermaid">${node.value}</pre>`,
13+
value: `<pre class="mermaid">${escapeHtml(node.value)}</pre>`,
1014
};
1115
});
1216
};

docs/scripts/sync-starlight.mjs

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,11 +56,19 @@ function rewriteDocsLinkTarget(target) {
5656
}
5757
}
5858

59-
/** Map USER_GUIDE anchors to the new `using/` directory. */
59+
/** Map USER_GUIDE anchors to the new `using/` and `customizing/` directories. */
6060
const userGuideAnchorRoutes = {
61+
overview: '/using/overview',
6162
authentication: '/using/authentication',
62-
'repository-onboarding': '/using/repository-onboarding',
63+
'repository-onboarding': '/customizing/repository-onboarding',
64+
'per-repo-overrides': '/customizing/per-repo-overrides',
65+
'task-types': '/using/task-types',
66+
'using-the-rest-api': '/using/using-the-rest-api',
67+
'using-the-cli': '/using/using-the-cli',
68+
'webhook-integration': '/using/webhook-integration',
6369
'task-lifecycle': '/using/task-lifecycle',
70+
'what-the-agent-does': '/using/what-the-agent-does',
71+
'tips-for-being-a-good-citizen': '/using/tips-for-being-a-good-citizen',
6472
};
6573
if (stem === 'USER_GUIDE' && anchor) {
6674
const splitRoute = userGuideAnchorRoutes[anchor.toLowerCase()];
@@ -176,6 +184,26 @@ splitGuide(
176184
'Using the platform',
177185
);
178186

187+
// Move customization pages from using/ to customizing/ (they belong under the Customizing sidebar section)
188+
const customizingPages = ['Repository-onboarding.md', 'Per-repo-overrides.md'];
189+
for (const page of customizingPages) {
190+
const src = path.join(docsRoot, 'src', 'content', 'docs', 'using', page);
191+
const dest = path.join(docsRoot, 'src', 'content', 'docs', 'customizing', page);
192+
if (fs.existsSync(src)) {
193+
fs.mkdirSync(path.dirname(dest), { recursive: true });
194+
fs.renameSync(src, dest);
195+
}
196+
}
197+
198+
// Remove orphaned stubs generated by splitGuide that have no useful content
199+
const orphanedPages = ['Introduction.md', 'Prerequisites.md'];
200+
for (const page of orphanedPages) {
201+
const filePath = path.join(docsRoot, 'src', 'content', 'docs', 'using', page);
202+
if (fs.existsSync(filePath)) {
203+
fs.unlinkSync(filePath);
204+
}
205+
}
206+
179207
// --- Quick Start: mirror to getting-started/ ---
180208
mirrorMarkdownFile(
181209
path.join(docsRoot, 'guides', 'QUICK_START.md'),
@@ -201,6 +229,9 @@ mirrorMarkdownFile(
201229
);
202230

203231
// --- Design docs: mirror to architecture/ ---
232+
// Source lives at docs/design/ but renders at /architecture/ on the site.
233+
// We keep the source directory named "design" because that's what CLAUDE.md and
234+
// AGENTS.md reference for contributors. The rename happens only at the site level.
204235
mirrorDirectory(path.join(docsRoot, 'design'), path.join('src', 'content', 'docs', 'architecture'));
205236

206237
// Guardrail: ensure target tree exists when running in a clean checkout.
File renamed without changes.

docs/src/content/docs/using/Repository-onboarding.md renamed to docs/src/content/docs/customizing/Repository-onboarding.md

File renamed without changes.

docs/src/content/docs/using/Introduction.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

docs/src/content/docs/using/Prerequisites.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

yarn.lock

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)