diff --git a/docs/README.md b/docs/README.md index 2ade75da..5f24a9df 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,55 +1,26 @@ -# Archivox +# SeedPass Docs -Archivox is a lightweight static site generator aimed at producing documentation sites similar to "Read the Docs". Write your content in Markdown, run the generator, and deploy the static files anywhere. +This directory contains SeedPass project documentation. -[![Build Status](https://github.com/PR0M3TH3AN/Archivox/actions/workflows/ci.yml/badge.svg)](https://github.com/PR0M3TH3AN/Archivox/actions/workflows/ci.yml) +## Core Security Docs -## Features -- Markdown based pages with automatic navigation -- Responsive layout with sidebar and search powered by Lunr.js -- Simple configuration through `config.yaml` -- Extensible via plugins and custom templates +- `security_readiness_checklist.md` +- `threat_model.md` +- `crypto_key_management_review.md` +- `secret_handling_local_exposure_review.md` +- `auth_lock_unlock_access_review.md` -## Getting Started -Install the dependencies and start the development server: +## Architecture and Product Docs -```bash -npm install -npm run dev -``` +- `ARCHITECTURE.md` +- `SPEC.md` +- `security.md` +- `nostr_setup.md` +- `packaging.md` -The site will be available at `http://localhost:8080`. Edit files inside the `content/` directory to update pages. +## QA and Testing Docs -To create a new project from the starter template you can run: - -```bash -npx create-archivox my-docs --install -``` - -## Building -When you are ready to publish your documentation run: - -```bash -npm run build -``` - -The generated site is placed in the `_site/` folder. - -## Customization -- **`config.yaml`** – change the site title, theme options and other settings. -- **`plugins/`** – add JavaScript files exporting hook functions such as `onPageRendered` to extend the build process. -- **`templates/`** – modify or replace the Nunjucks templates for full control over the HTML. - -## Hosting -Upload the contents of `_site/` to any static host. For Netlify you can use the provided `netlify.toml`: - -```toml -[build] - command = "npm run build" - publish = "_site" -``` - -## Documentation -See the files under the `docs/` directory for a full guide to Archivox including an integration tutorial for existing projects. - -Archivox is released under the MIT License. +- `agent_testing_roadmap.md` +- `ai_agent_tui_testing.md` +- `installer_testing.md` +- `ci-health-2026-02-19.md` diff --git a/docs/src/config/loadConfig.js b/docs/src/config/loadConfig.js index 4cba23af..612296ff 100644 --- a/docs/src/config/loadConfig.js +++ b/docs/src/config/loadConfig.js @@ -30,7 +30,7 @@ function loadConfig(configPath = path.join(process.cwd(), 'config.yaml')) { const defaults = { site: { - title: 'Archivox', + title: 'SeedPass Docs', description: '', logo: '', favicon: '' diff --git a/memory-update.md b/memory-update.md index 6933ab52..d370b96b 100644 --- a/memory-update.md +++ b/memory-update.md @@ -1,34 +1,8 @@ # Memory Update (2026-02-25) -## Security Checklist Progress -- Item 6 (`Auth, lock/unlock, and access-control hardening`) moved to `Done`. +## Docs Cleanup +- Replaced `docs/README.md` content that referenced Archivox with a SeedPass-focused docs index. +- Updated docs-site default title in `docs/src/config/loadConfig.js` from `Archivox` to `SeedPass Docs`. -## Final Item 6 Hardening Completed -1. Added locked-state API enforcement across protected admin/config/data routes (`423` when locked). -2. Added explicit API unlock endpoint (`POST /api/v1/vault/unlock`). -3. Added dedicated unlock-failure throttling in `seedpass/api.py` (returns `429` after repeated failed unlock attempts). -4. Blocked sensitive config keys in generic config API: - - `password_hash` - - `pin_hash` -5. Preserved pre-unlock operational path by keeping fingerprint list/select available while locked. - -## Regression Coverage Added -- `test_vault_unlock_endpoint` -- `test_vault_unlock_rate_limited_after_failed_attempts` -- `test_entry_endpoints_blocked_when_vault_locked` -- `test_generate_password_blocked_when_vault_locked` -- `test_config_endpoint_blocked_when_vault_locked` -- `test_get_config_denies_sensitive_keys` -- `test_lock_unlock_cycle_restores_entry_access` - -## Validation -- Executed: - - `src/tests/test_api_new_endpoints.py` - - `src/tests/test_api.py` - - `src/tests/test_vault_lock_flag.py` - - `src/tests/test_inactivity_lock.py` - - `src/tests/test_unlock_sync.py` -- Result: `66 passed`. - -## Next Checklist Candidate -- Item #8 (`Supply chain and release integrity`) is the next major `Not Started` security item. +## Outcome +- Removed stale Archivox branding from the docs README and default docs title so the correct SeedPass README/content is displayed.