docs(pages): add current product documentation hub - #650
Closed
seonghobae wants to merge 2 commits into
Closed
Conversation
seonghobae
added
the
documentation
ChatGPT Codex Connector
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
Comment on lines
+46
to
+49
| <a class="card" href="user-guide.md"><strong>User guide</strong><span>Plan, edit, analyze, import/export, and use the planner.</span></a> | ||
| <a class="card" href="api.md"><strong>API reference</strong><span>Cloud/SaaS endpoints and integration contracts.</span></a> | ||
| <a class="card" href="deploy.md"><strong>Deployment guide</strong><span>Runtime configuration and deployment boundaries.</span></a> | ||
| <a class="card" href="security.md"><strong>Security notes</strong><span>Authentication, tenancy, secrets, and fail-closed expectations.</span></a> |
There was a problem hiding this comment.
🟡 Documentation cards expose raw Markdown
The four cards link to .md files in an unprocessed Pages artifact. Browsers display Markdown source instead of rendered product documentation.
Prompt for agents
The documentation hub in docs/index.html links directly to docs/user-guide.md, docs/api.md, docs/deploy.md, and docs/security.md. The Pages workflow uploads _site as a static artifact and performs no Markdown-to-HTML build, so these URLs expose source Markdown. Add a rendering step that produces HTML for these documents and update the cards to those outputs, or link to an existing renderer such as the repository's GitHub blob pages. Ensure all generated files are included in the uploaded artifact and relative links continue to work under the /scopeweave/docs/ project path.
Was this helpful? React with 👍 or 👎 to provide feedback.
Comment on lines
+8
to
+24
| <style> | ||
| :root { color-scheme: light dark; font-family: Inter, ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", sans-serif; } | ||
| body { margin: 0; line-height: 1.6; } | ||
| main { max-width: 920px; margin: 0 auto; padding: 48px 24px 72px; } | ||
| h1 { font-size: clamp(2.2rem, 7vw, 4.6rem); line-height: 1; margin: 0 0 20px; letter-spacing: -0.04em; } | ||
| h2 { margin-top: 42px; } | ||
| .lede { font-size: 1.18rem; max-width: 760px; } | ||
| .status { border-left: 4px solid currentColor; padding: 12px 16px; margin: 28px 0; opacity: .86; } | ||
| .grid { display: grid; grid-template-columns: repeat(auto-fit, minmax(230px, 1fr)); gap: 14px; margin: 22px 0; } | ||
| .card { display: block; border: 1px solid currentColor; border-radius: 14px; padding: 18px; text-decoration: none; } | ||
| .card strong { display: block; margin-bottom: 6px; } | ||
| .card span { opacity: .75; } | ||
| .actions { display: flex; flex-wrap: wrap; gap: 12px; margin: 28px 0; } | ||
| .actions a { border: 1px solid currentColor; border-radius: 999px; padding: 9px 14px; text-decoration: none; } | ||
| code { font-family: ui-monospace, SFMono-Regular, Menlo, Consolas, monospace; } | ||
| footer { margin-top: 56px; opacity: .72; font-size: .95rem; } | ||
| </style> |
There was a problem hiding this comment.
🔍 Documentation hub embeds its stylesheet
The <style> block bypasses the repository rule to extend styles.css. Move these rules into a staged stylesheet to keep client presentation centralized.
Was this helpful? React with 👍 or 👎 to provide feedback.
seonghobae
added
priority: medium
ChatGPT Codex Connector
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Superseded by canonical README/public-surface lane
Closed without merge after preserving the complete unique delta in #651.
docs/index.htmlfrom this branch is now present ondocs/readme-product-first-20260902;docs/index.html,docs/user-guide.md,docs/api.md,docs/deploy.md, anddocs/security.mdis also present there;Canonical successor: #651 exact head
62dfd3523428ef4aba47964b19ae9f5cadb423ebat closure. It owns the product-first root README and the deployable public documentation hub together, eliminating drift between separate README and Pages writers.This closure itself is not merge evidence for #651; the successor must reacquire all exact-head checks/reviews after the fold.