Skip to content

Docs/fix docs structure - #7

Merged
tonyopenbox merged 5 commits into
developfrom
docs/fix-docs-structure
Feb 20, 2026
Merged

Docs/fix docs structure#7
tonyopenbox merged 5 commits into
developfrom
docs/fix-docs-structure

Conversation

@tonyopenbox

@tonyopenbox tonyopenbox commented Feb 16, 2026

Copy link
Copy Markdown
Collaborator
  • Overview
  • Getting Started
    • Getting Started Overview
    • Quick Start
  • Core Concepts
    • Trust Scores
    • Trust Tiers
    • Governance Decisions
  • Trust Lifecycle
    • Trust Lifecycle Overview
    • Assess
    • Authorize
    • Monitor
    • Verify
    • Adapt
  • Developer Guide
    • SDK Overview
    • Temporal (Workflow Engines)
    • Configuration
    • Error Handling
    • Event Types
    • Troubleshooting
  • Dashboard
    • Dashboard Overview
    • Agents Overview
    • Registering Agents
    • Trust Overview
    • Alerts
  • Approvals
    • Approvals Overview
  • Administration
    • Organization Overview
    • Compliance Overview
    • Attestation
    • Audit Log

@vercel

vercel Bot commented Feb 16, 2026

Copy link
Copy Markdown

@tonyopenbox must be a member of the Platform team on Vercel to deploy.
- Click here to add @tonyopenbox to the team.
- If you initiated this build, request access.
- If you're already a member of the Platform team, make sure that your Vercel account is connected to your GitHub account.

Learn more about collaboration on Vercel and other options here.

@tonyopenbox tonyopenbox self-assigned this Feb 16, 2026
This covers the reordering from learning > understanding > doing > operating > governing flow

- Overview
- Getting Started
  - Getting Started
  - Registering Agents
  - Quick Start
- Core Concepts
  - Trust Scores
  - Trust Tiers
  - Governance Decisions
- Trust Lifecycle
  - Trust Lifecycle
  - Assess
  - Authorize
  - Monitor
  - Verify
  - Adapt
- Developer Guide
  - SDK Reference
  - Temporal Integration
  - Configuration
  - Error Handling
  - Event Types
- Dashboard
  - Dashboard
  - Agents
  - Trust Overview
  - Alerts
- Approvals
  - Approvals
  - Approval Workflows
- Administration
  - Organization
  - Compliance
  - Attestation
  - Audit Log
@nat294
nat294 force-pushed the docs/fix-docs-structure branch from bfbbbbf to 1c9d383 Compare February 19, 2026 13:30
@vercel

vercel Bot commented Feb 19, 2026

Copy link
Copy Markdown

@nat294 must be a member of the Platform team on Vercel to deploy.
- Click here to add @nat294 to the team.
- If you initiated this build, request access.
- If you're already a member of the Platform team, make sure that your Vercel account is connected to your GitHub account.

Learn more about collaboration on Vercel and other options here.

@nat294
nat294 marked this pull request as ready for review February 19, 2026 13:39
@nat294

nat294 commented Feb 19, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Restructure sidebar navigation around user journey: Learning → Understanding → Doing → Operating → Governing
  • Address documentation review feedback items (homepage clarity, glossary, quick start improvements, active voice, terminology)
  • Replace all "AIVSS" references with "Risk Profile" across the documentation (licensing requirement)
  • Fix Next Steps links across all pages to align with the new sidebar order

Changes

Sidebar Rearrangement

  • Moved Troubleshooting from Getting Started → Developer Guide (after Event Types)
  • Moved Registering Agents from Getting Started → Dashboard section (after Agents Overview)
  • Removed Agent Overview page from sidebar (content accessible via Agents Detail page)

Documentation Review Fixes

  • Homepage Clarity — Added "The Problem", "The Solution", "Who This Is For", and "Key Capabilities" sections with clear CTA cards
  • Glossary — Created dedicated glossary page defining all key terms (Risk Profile, Trust Score, Governance Decision, Behavioral Rules, etc.)
  • Quick Start — Added expected output log snippet, troubleshooting tip, account setup guidance with signup link
  • Agents Intro — Added introductory sentence explaining what an Agent is in OpenBox context
  • Active Voice — Revised 9 passive voice sentences across governance-decisions.md, quick-start.md, and compliance/index.md

Terminology

  • Replaced all AIVSS references with Risk Profile across all documentation files (Bi request)

Navigation

  • Fixed self-referencing link in Approvals page
  • Updated Next Steps sections on 13 pages to point forward in the new sidebar order
  • Added missing Next Steps sections to Agents Overview, Compliance, and Attestation pages
  • Renamed backward-only "Next Steps" to "Related" on Audit Log and Attestation pages

Not Included

  • Compliance claim scoping ("tamper-proof" → "cryptographically signed") — deferred pending tech lead review (Bi and Ice)

Document Order & Verified Next Steps

Overview (Homepage)

  • Next Steps: Cards linking to Quick Start, Trust Lifecycle, Dashboard, Agents, Approvals, SDK, Compliance ✅

Getting Started

  • Getting Started Overview → Next Steps: Quick Start, Temporal Integration ✅
  • Quick Start → Next Steps: Authorize, Monitor, Approvals, Configuration ✅

Core Concepts

  • Trust Scores → Related: Trust Tiers, Assess, Adapt ✅
  • Trust Tiers → Related: Governance Decisions, Dashboard ✅
  • Governance Decisions → Related: Authorize, Approvals ✅

Trust Lifecycle

  • Trust Lifecycle Overview → Next Steps: Assess, Authorize, Monitor, Verify, Adapt ✅
  • Assess → Next Phase: Authorize ✅
  • Authorize → Next Phase: Monitor ✅
  • Monitor → Next Phase: Verify ✅
  • Verify → Next Phase: Adapt ✅
  • Adapt → Next Steps: Authorize, Assess (cyclical), Approvals ✅

Developer Guide

  • SDK Overview → Next Steps: Temporal, Configuration, Error Handling ✅
  • Temporal → Next Steps: Configuration, Error Handling, Approvals ✅
  • Configuration → Next Steps: Error Handling, Event Types, Approvals ✅
  • Error Handling → Next Steps: Event Types, Troubleshooting, Approvals ✅
  • Event Types → Related: Troubleshooting, Governance Decisions, Authorize ✅
  • Troubleshooting → Next Steps: Dashboard, Agents Overview, Approvals ✅

Dashboard

  • Dashboard Overview → Next Steps: Agents, Approvals, Registering Agents ✅
  • Agents Overview → Next Steps: Registering Agents, Trust Overview ✅
  • Registering Agents → Next Steps: Trust Overview, Alerts, Approvals ✅
  • Trust Overview → Next Steps: Alerts, Agents ✅
  • Alerts → Next Steps: Agents, Verify, Approvals ✅

Approvals

  • Approvals Overview → Next Steps: Organization, Monitor ✅

Administration

  • Organization Overview → Next Steps: Audit Log, Compliance ✅
  • Compliance Overview → Next Steps: Attestation, Audit Log ✅
  • Attestation → Related: Audit Log, Compliance ✅
  • Audit Log → Related: Compliance, Attestation ✅ (last page)

Feedback Items Status (Kisso's)

  • Homepage Clarity (High) — Done
  • Terminology Definition / Glossary (High) — Done
  • Quick Start Expected Output (High) — Done
  • Account Setup Guidance (Medium) — Done
  • Quick Start Troubleshooting (Medium) — Done
  • Conceptual Clarity (Agents) (Medium) — Done
  • Compliance Claim Scoping (Low) — Deferred, pending tech lead review
  • Active Voice Adoption (Low) — Done
  • AIVSS → Risk Profile rename — Done (Bi comment)
  • Next Steps / Navigation alignment — Done (all 28 pages verified)

@nat294 nat294 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This one is good idea, approval is just one page so this one is nice, so no need for nested nav

@nat294 nat294 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This one I also approved, very nice and thanks again for adding session replay boss :D

@tonyopenbox
tonyopenbox merged commit 725a7f4 into develop Feb 20, 2026
1 check failed
@tonyopenbox
tonyopenbox deleted the docs/fix-docs-structure branch February 20, 2026 07:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants