feat: generate index pages for api/ and api/{framework}/#592
Conversation
akudev
force-pushed
the
fix/api-index-pages
branch
from
26b4636 to
16093f1
Compare
There was a problem hiding this comment.
Pull request overview
Adds generation of navigable index.html pages under the published API docs site so /api/, /api/openui5/, and /api/sapui5/ don’t 404 and instead list available generated versions.
Changes:
- Updates the workflow_dispatch input description to clarify version entry formats.
- Adds a
gh-pagesstep that scans generated version directories and writesapi/index.htmlplus per-frameworkapi/{framework}/index.htmlpages.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
akudev
force-pushed
the
fix/api-index-pages
branch
from
16093f1 to
d2164d9
Compare
codeworrior
left a comment
codeworrior
left a comment
There was a problem hiding this comment.
some minor things, but looks okay
After doc generation, scan the existing version directories and build index.html pages listing all available versions. This makes /api/, /api/openui5/, and /api/sapui5/ navigable instead of 404.
akudev
force-pushed
the
fix/api-index-pages
branch
from
d2164d9 to
305cdfc
Compare
| <title>UI5 TypeScript API Reference</title> | ||
| <meta name="description" content="Crawlable TypeScript API documentation for OpenUI5 and SAPUI5"> | ||
| <meta name="viewport" content="width=device-width,initial-scale=1"> | ||
| <link rel="canonical" href="https://ui5.github.io/typescript/api/"> |
There was a problem hiding this comment.
Claude says: The main index uses << 'EOF' (single-quoted — no variable expansion) so the canonical URL is hardcoded. ${BASE} is used in the framework-specific index which uses << EOF (unquoted — expansion works). The hardcoded value is correct since this URL never changes.
There was a problem hiding this comment.
Then, Claude has no interest in a consistent coding style, I fear. It's okay for AI, but not for me.
"since this URL never changes" is true for all places where ${BASE} is used.
After doc generation, scan the existing version directories and build index.html pages listing all available versions. This makes /api/, /api/openui5/, and /api/sapui5/ navigable instead of 404.