-
Notifications
You must be signed in to change notification settings - Fork 0
docs(pages): add current product documentation hub #650
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| <!doctype html> | ||
| <html lang="en"> | ||
| <head> | ||
| <meta charset="utf-8"> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1"> | ||
| <meta name="description" content="ScopeWeave product, architecture, onboarding, API, deployment, security, and release navigation."> | ||
| <title>ScopeWeave Docs</title> | ||
| <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> | ||
| </head> | ||
| <body> | ||
| <main> | ||
| <h1>ScopeWeave</h1> | ||
| <p class="lede">Schedule-control WBS planning that works as a standalone static planner and as a Cloud/SaaS workspace over the same planning model.</p> | ||
|
|
||
| <div class="actions"> | ||
| <a href="../">Open planner</a> | ||
| <a href="https://github.com/ContextualWisdomLab/scopeweave">GitHub repository</a> | ||
| <a href="https://github.com/ContextualWisdomLab/scopeweave/releases">Releases</a> | ||
| <a href="https://deepwiki.com/ContextualWisdomLab/scopeweave">Ask DeepWiki</a> | ||
| </div> | ||
|
|
||
| <p class="status"><strong>Publication truth:</strong> this documentation hub describes capabilities present on protected <code>develop</code>. Open pull requests and planned migrations are not shipped product evidence until integrated and revalidated.</p> | ||
|
|
||
| <h2>Product responsibility</h2> | ||
| <p>ScopeWeave owns schedule-control planning, WBS hierarchy and editing, deterministic schedule analysis, portable project data, and the optional authenticated cloud collaboration layer. Standalone operation remains a product invariant: cloud capabilities must not make local planning depend on a server, database, credential, or model.</p> | ||
| <p>Protected <code>develop</code> includes the static planner plus a Node/Hono Cloud/SaaS runtime with account, tenant, collaboration, billing/entitlement, audit, search, integration, and observability surfaces. The current protected persistence profile uses Node SQLite; planned PostgreSQL work is not described here as already shipped.</p> | ||
|
|
||
| <h2>Start here</h2> | ||
| <div class="grid"> | ||
| <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> | ||
|
Comment on lines
+46
to
+49
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟡 Documentation cards expose raw Markdown The four cards link to Prompt for agentsWas this helpful? React with 👍 or 👎 to provide feedback. |
||
| <a class="card" href="https://github.com/ContextualWisdomLab/scopeweave/blob/develop/ARCHITECTURE.md"><strong>Architecture</strong><span>As-built authority, trust boundaries, and service composition.</span></a> | ||
| <a class="card" href="https://github.com/ContextualWisdomLab/scopeweave/blob/develop/CHANGELOG.md"><strong>Changelog</strong><span>Protected product changes and unreleased work classification.</span></a> | ||
| </div> | ||
|
|
||
| <h2>Architecture at a glance</h2> | ||
| <p>The static browser planner owns the canonical standalone interaction model. <code>cloud-sync.js</code> adds an optional authenticated cloud overlay. The server layer owns cloud HTTP/API composition, authentication, tenancy, current SQLite persistence, billing boundaries, document integration, bounded attachment refresh, and contextual-orchestrator integration. Cross-service systems are consumed through explicit APIs/adapters rather than shared application databases.</p> | ||
|
|
||
| <h2>Onboarding</h2> | ||
| <p>For a no-server evaluation, open the planner on this Pages site or serve the repository with a local static HTTP server. For the Cloud/SaaS profile, install the pinned Node dependencies, provide a durable JWT signing secret, run the server, and follow the deployment guide before exposing the service. Integration consumers should start with the API reference and keep tenant and authorization decisions server-owned.</p> | ||
|
|
||
| <h2>Verification and release boundary</h2> | ||
| <p>Repository-native unit/API, browser, coverage, fuzz, dependency, OSV, and security workflows plus organization-required protected checks form the integration evidence. Pending, skipped, cancelled, failed, stale, predecessor-head, or model-only evidence is not equivalent to a passing current revision. Published releases remain distinct from active pull-request behavior.</p> | ||
|
|
||
| <footer>ScopeWeave is maintained by ContextualWisdomLab. This Pages hub complements the interactive planner rather than replacing it.</footer> | ||
| </main> | ||
| </body> | ||
| </html> | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🔍 Documentation hub embeds its stylesheet
The
<style>block bypasses the repository rule to extendstyles.css. Move these rules into a staged stylesheet to keep client presentation centralized.Was this helpful? React with 👍 or 👎 to provide feedback.