laantungir/ngit-grasp

Fork 0

mirror of https://relay.ngit.dev/npub15qydau2hjma6ngxkl2cyar74wzyjshvl65za5k5rl69264ar2exs5cyejr/ngit-grasp.git synced 2026-10-06 07:28:23 +00:00

Files

T

History

DanConwayDev fa36794d7e fix(git): verify already-completed deletion pushes without writes

A stale deletion still required a pending state after background promotion had
already removed the ref. Rewriting its old OID to zero is unsafe: receive-pack
can interpret that command as an unconditional deletion of a recreated ref.

For fully satisfied unsigned pushes containing ordinary-ref deletions, retain
normal repository and PR authorization, then verify all requested targets in
one Git ref transaction. Verification checks absent refs and existing targets
without issuing updates or deletes. Report success at that transaction point,
respecting report-status/v2 and sideband framing, without unpacking redundant
objects. Recreated or changed refs fail verification and remain untouched.

Only fully satisfied requests take this path. Pushes making changes still use
receive-pack; certificates, malformed and duplicate commands do not take the
shortcut. This does not authorize new targets from stored state or objects.

Validation: the deletion reproduction previously failed with missing purgatory
authorization and now passes in ordinary and sideband status-v2 modes. The
949-test library suite and 202 selected Git integration tests passed; all four
final completed-push tests pass, including ref recreation and companion-ref
changes between inspection and verification. Strict all-target Clippy passed.

Assisted-by: GPT-6

2026-09-25 13:32:38 +00:00

explanation

fix(git): verify already-completed deletion pushes without writes

2026-09-25 13:32:38 +00:00

grafana

feat(sync): Phase 6 - observability and production readiness

2025-12-04 18:43:49 +00:00

how-to

test(sync): make dependency batching regression deterministic

2026-09-21 15:01:27 +00:00

learnings

docs: remove obsolete archive and migration materials

2026-09-24 06:52:36 +00:00

reference

fix(logging): omit raw relay payloads from SDK diagnostics

2026-09-24 10:56:44 +00:00

tutorials

docs: use Diátaxis structure

2025-11-04 10:25:53 +00:00

README.md

docs: remove obsolete archive and migration materials

2026-09-24 06:52:36 +00:00

README.md

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

Getting Started - Your first ngit-grasp setup
Running Your First Audit - Using grasp-audit tool

🔧 How-To Guides - Solving Problems

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

Deploy ngit-grasp - Choose Docker, NixOS, Linux, Proxmox, or managed hosting
Deployment contract - Shared runtime and persistence requirements
Configure Nix Flakes - Nix development environment
Run Compliance Tests - GRASP compliance testing
Upgrade nostr-sdk - Handling SDK upgrades

📖 Reference - Technical Information

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

Git Protocol - Git Smart HTTP protocol details
GRASP Protocol - GRASP specification details
Configuration - All config options
API Reference - Internal API documentation

💡 Explanation - Understanding Concepts

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

Architecture Overview - System design and components
Inline Authorization - Why we chose this approach
Administration Vision - Nostr-authenticated management, embedded UI, and runtime configuration
Comparison with ngit-relay - How we differ from reference
Design Decisions - Key architectural choices

🚀 Quick Start Paths

I'm brand new to ngit-grasp

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

I want to deploy ngit-grasp

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

I want to develop on ngit-grasp

I want to understand the design

I'm looking for specific information

Protocol details? → Reference
Configuration options? → Configuration Reference
Git protocol? → Git Protocol Reference

📂 Additional Resources

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)

🔗 External Links

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