Files
ngit-grasp/docs
DanConwayDev 6e9bf5981b fix(lifecycle): preserve NIP-01 ordering through deletion and rollback
Same-second lower-ID replacements could be ignored by served-repository
de-listing and superseded-history capture. Rollback's active-state lookup
and post-deletion alignment instead preferred higher IDs, while history
selection let capture time override the original event's replacement order.

Share the later-timestamp/lower-ID comparator across these lifecycle paths
and the existing purgatory decisions. Archive a same-second predecessor only
when the incoming event wins, and only apply de-list deletion for a winning
replacement. Select active and authorized alignment states with the same
ordering. Rank history records by original timestamp and original event ID
before capture metadata; keep timestamp cutoffs and author checks intact.

Extract the authorized-state selection used by realignment to exercise both
arrival orders with different authorized authors and an unauthorized newer
state. Add served de-list, history-capture and history-candidate regressions.
All four new regressions fail before the fixes and pass afterward. Extend the
LMDB restart scenario to delete the same-second winner and observe its
archived predecessor restored, with a bounded deadline and no new sleeps.

This changes replacement preference, not deletion request ownership,
coordinate cutoff semantics, repository membership or archive format.
Existing capture metadata remains readable. Update the changelog and
repository lifecycle documentation.

Validation: focused ordering regressions and LMDB restart/rollback test;
full ngit-grasp suite, all-target workspace Clippy with warnings denied,
formatting and diff checks pass.

Assisted-by: GPT-6
2026-09-17 15:38:24 +00:00
..
2025-11-04 10:25:53 +00:00

ngit-grasp Documentation

Welcome to the ngit-grasp documentation! We use the Diátaxis framework to organize our documentation into four types, each serving a different purpose.

                    PRACTICAL          THEORETICAL
                    ─────────          ───────────
                    
LEARNING      │   Tutorials    │    Explanation   │
              │                │                  │
              │  Getting       │   Architecture   │
              │  Started       │   Decisions      │
              │                │                  │
              ├────────────────┼──────────────────┤
              │                │                  │
WORKING       │  How-To        │    Reference     │
              │  Guides        │                  │
              │                │   API Docs       │
              │  Deployment    │   Protocols      │
              │  Testing       │                  │
              │                │                  │

📚 Documentation Types

🎓 Tutorials - Learning by Doing

Purpose: Learn the basics through practical steps
For: Newcomers getting started
Style: Step-by-step lessons with guaranteed outcomes

🔧 How-To Guides - Solving Problems

Purpose: Accomplish specific tasks
For: Users with basic knowledge solving real problems
Style: Practical recipes and solutions

📖 Reference - Technical Information

Purpose: Look up technical details
For: Users who know what they're looking for
Style: Dry, factual, comprehensive

💡 Explanation - Understanding Concepts

Purpose: Understand the "why" and design decisions
For: Users wanting deeper understanding
Style: Discussion, context, alternatives


🚀 Quick Start Paths

I'm brand new to ngit-grasp

  1. Read README.md for project overview
  2. Follow Getting Started Tutorial
  3. Understand Architecture Overview

I want to deploy ngit-grasp

  1. Review Configuration Reference
  2. Choose an environment in Deploy ngit-grasp
  3. Verify the deployment and test its backup

I want to develop on ngit-grasp

  1. Follow Getting Started Tutorial
  2. Read Architecture Overview
  3. Check Nix Flakes How-To
  4. Review Test Strategy

I want to understand the design

  1. Read Inline Authorization Explanation
  2. Review Design Decisions
  3. Compare with ngit-relay Comparison

I'm looking for specific information


📂 Additional Resources

Archive

Historical session notes and completed work. Useful for understanding project evolution but not required reading.

Learnings

DEPRECATED - Being migrated to Diátaxis structure:

  • Gotchas → How-To Guides
  • Patterns → Reference or Explanation
  • Notes → Appropriate category

🤝 Contributing to Documentation

When adding documentation, ask yourself:

Is it a tutorial?

  • Does it teach a beginner?
  • Is it a complete lesson with guaranteed outcome?
  • → Add to tutorials/

Is it a how-to guide?

  • Does it solve a specific problem?
  • Is it a recipe for accomplishing a task?
  • → Add to how-to/

Is it reference material?

  • Is it technical information?
  • Will people look it up when needed?
  • → Add to reference/

Is it explanation?

  • Does it explain "why"?
  • Does it discuss alternatives or design?
  • → Add to explanation/

See Diátaxis documentation for more guidance.


📊 Project Status

ALPHA - Under active development. Core functionality working, API may change.

Completed

  • ✅ grasp-audit compliance testing tool
  • ✅ Nix flake development environment
  • ✅ nostr-sdk 0.43 upgrade
  • ✅ Documentation restructure (Diátaxis)

In Progress

  • 🔄 Core ngit-grasp server implementation
  • 🔄 GRASP-01 compliance

Planned

  • 🔜 GRASP-02 (Proactive Sync)
  • 🔜 GRASP-05 (Archive)


Documentation structure based on Diátaxis
Last updated: November 4, 2025