Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@ jobs:
with:
enablement: true

- name: Stage runtime files
- name: Stage runtime and documentation files
run: |
mkdir -p _site/docs
cp index.html 404.html app.js cloud-sync.js analytics.js styles.css toast-state.css wbs.json _site/
cp docs/user-guide.md _site/docs/
cp docs/index.html docs/user-guide.md docs/api.md docs/deploy.md docs/security.md _site/docs/

- name: Upload static artifact
uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9
Expand Down
66 changes: 66 additions & 0 deletions docs/index.html
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>
Comment on lines +8 to +24

Copy link
Copy Markdown

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 extend styles.css. Move these rules into a staged stylesheet to keep client presentation centralized.

Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.

</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

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 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.
Devin Review

Was 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>
Loading