Skip to content

Migrate and Verify VectorNNTPD Documentation - #257

Merged
enteriaza merged 1 commit into
masterfrom
docs
Oct 29, 2026
Merged

enteriaza merged 1 commit into
masterfrom
docs

Conversation

@enteriaza

Copy link
Copy Markdown
Collaborator

Summary

Migrate relevant existing documentation into the VectorNNTPD solution, update outdated material against the current implementation, and establish a clearer documentation structure for developers and operators.

This PR preserves useful upstream standards and reference material while distinguishing it from functionality and configuration actually implemented by VectorNNTPD.

Changes

StorageService Documentation

  • Add a StorageService architecture and configuration guide.
  • Document configuration sources, defaults, validation, environment variables, startup, readiness, shutdown, logging, and operational dependencies.
  • Document the NNTP feed protocol, including ARTICLE, TAKETHIS, and QUIT.
  • Clarify response semantics, article-size enforcement, queue-commit boundaries, and downstream persistence limitations.
  • Document the cache.broadcast v1 advertisement contract, publication cadence, message expiration, and current capacity-reporting behaviour.

Documentation Migration

  • Migrate and adapt logging and systemd documentation.
  • Add a documentation index and improve navigation between related guides.
  • Migrate relevant SQL schema references and standards documentation.
  • Add upstream NNTPD command and PostFilter reference material.
  • Update the root README and architecture documentation.

Accuracy and Maintenance

  • Verify configuration and protocol claims against the current implementation.
  • Correct environment-variable names and configuration-precedence descriptions.
  • Clarify that upstream SQL files are reference material, not VectorNNTPD provisioning scripts.
  • Explicitly document that the current StorageService hosting configuration does not register Article Work consumers or a cache.requests consumer.
  • Clarify that capacity advertisements currently report zero capacity values through NoSpoolCapacityReader.

Validation

  • Verified documentation against the current source implementation.
  • Checked 136 relative links with zero failures.
  • Confirmed no changes to application source code or tests.
  • Build not run because the changes are documentation-only.

Known Limitations

  • The MySQL DDL for nntpsharedconfig and nntpbackfilleraccounts is not checked into this repository.
  • Capacity advertisement values will need to be revisited if a real IStorageCapacityReader replaces NoSpoolCapacityReader.
  • NNTPD-side consumption of capacity advertisements is outside the scope of this solution's shipping hosts.
  • ReaderService and TransitService documentation remains deferred until those projects are included in the solution.

Scope

Documentation and reference material only. No application behaviour, dependencies, or tests have been changed.

- Add StorageService architecture and configuration guide
- Document NNTP feed command and response behaviour
- Migrate logging, systemd, schema, and standards references
- Clarify upstream-only documentation and database schemas
- Update documentation index and cross-references
@enteriaza enteriaza self-assigned this Oct 29, 2026
@enteriaza enteriaza added the enhancement New feature or request label Oct 29, 2026
@enteriaza
enteriaza merged commit c2806b5 into master Oct 29, 2026
5 of 6 checks passed
@enteriaza
enteriaza deleted the docs branch October 29, 2026 16:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant