Skip to content

modules.md

Latest commit

 

History

History
88 lines (81 loc) · 10 KB

modules.md

File metadata and controls

88 lines (81 loc) · 10 KB
Raw

Module Docs

This is the root index for module-owned docs. Keep each entry short here: what the module is for, and where its docs live when it has them. Detailed plans, flows, and implementation notes belong under app/modules/<module>/docs/.

Documented Modules

Module Inventory

Module Purpose Docs
accountStorage Stores local static-id peer keys and remote public-key records used by user, group, and manifest identity flows. Overview
activityPub Federates public GeeSome groups/posts and reads remote ActivityPub source feeds. Overview, research, flows, live interop
api Runs the Express HTTP server, route registration/auth wrappers, discovery/OpenAPI/apiDoc serving, and core setup/auth/user/admin/storage helper routes. Overview
asyncOperation Tracks long-running user operations and processes queued background work. Overview
autoActions Stores and claims scheduled module function calls. Overview
bluesky Imports, refreshes, reads local feed views, verifies user-scoped accounts, and cross-posts safe text/image posts for native Bluesky/ATProto. Overview
communicator Provides network communication, static-id lookup/binding, and pubsub-style event hooks. Overview
content Creates, serves, previews, restores, and deletes user content records. Overview
database Owns Sequelize setup, models, permissions, API keys, sessions, and shared query helpers. Overview
drivers Registers media/file preview, upload, metadata, and conversion drivers. Overview
entityJsonManifest Builds and reads GeeSome JSON manifests for users, content, groups, posts, categories, and generated group post-index state. Overview
ethereumAuthorization Verifies Ethereum signatures for auth-message login and registration flows that invoke the registration-validation hook. Overview
fileCatalog Manages user/group folder trees and path-based content organization. Overview
foreignAccounts Stores user-linked external account claims, provider-address lookups, and manifest proof export. Overview
gateway Serves frontend assets and a DNSLink-based public content gateway for IPFS/IPNS-style GET/HEAD requests. Overview
group Owns groups, memberships, posts, permissions, post contents, and group manifests. Overview
groupCategory Manages category records, group/category pivots, category member/admin pivots, category-derived post feeds, and group-section placement. Overview
imageComposition Owns semantic SVG overlays, composition persistence, idempotency, optimistic revisions, and the compatible group-scoped composition API facade. Overview
invite Manages invite-code status, rate-limited public join/register flows, invite-derived permissions/limits, optional group joins, and invite lifecycle. Overview
pin Stores pinning accounts and sends storage pin requests. Overview
remoteContentModeration Provides reusable policy helpers for review-first/auto-import decisions and bounded keyword/regex/source/group filters before remote content becomes visible posts. Overview
remoteGroup Imports or refreshes GeeSome groups/posts from remote manifest storage IDs or static IDs, and backs local-or-remote group lookup. Overview
rss Generates bounded public RSS XML feeds for group posts. Overview
socNetAccount Stores per-user credential and identity rows for social-network client modules, currently Telegram and Twitter/X. Overview
socNetImport Provides the shared channel/message/post pipeline for social-network imports. Overview
staticId Manages static ID binding/history/resolution, account/group static identities, and public IPNS-style resolve/stream routes. Overview
staticSiteGenerator Generates static sites for groups and bounded content lists, including group post pages, and manages render state. Overview
storage Wraps the configured storage backend for files, directories, streams, and storage IDs. Overview
storageSpace Analyzes storage usage, reference state, cleanup blockers, and availability signals. Overview
telegramClient Imports Telegram account/channel data through the shared social-import pipeline. Overview
tgContentBot Provides Telegram bot flows for content upload and user interaction. Overview
twitterClient Imports Twitter/X account/channel data through the shared social-import pipeline. Overview

Documentation Plan

  1. Core module overviews are in place for database, group, content, storage, entityJsonManifest, fileCatalog, and storageSpace.
  2. Background-worker and async-flow overviews are in place for asyncOperation, autoActions, pin, staticSiteGenerator, socNetImport, activityPub, and bluesky.
  3. Integration overviews are in place for telegramClient, twitterClient, tgContentBot, remoteGroup, and communicator.
  4. API/security/identity overviews are in place for api, invite, foreignAccounts, ethereumAuthorization, socNetAccount, accountStorage, and staticId.
  5. Utility/feed/moderation-helper and composition overviews are in place for drivers, gateway, groupCategory, imageComposition, remoteContentModeration, and rss.
  6. Subagent review pass completed across all module inventory rows and overview docs; keep future reviews focused on code ownership, public API, models/storage, background jobs, user-facing behavior, and integration boundaries.
  7. Add the module-doc index to the same runtime docs-discovery path as API docs: the future docs/README.md portal and /v1 discovery JSON should point agents and users to this file and to the published IPFS path when docs are pinned.
  8. Keep this index updated whenever a module gains docs, but keep detailed behavior, schemas, route lists, and migration notes inside the module docs folder.