Skip to content

docs: reconcile README with module and script inventory - #278

Open
Wang1rrr wants to merge 1 commit into
Chulilee:mainfrom
Wang1rrr:docs/readme-module-reference
Open

Wang1rrr wants to merge 1 commit into
Chulilee:mainfrom
Wang1rrr:docs/readme-module-reference

Conversation

@Wang1rrr

@Wang1rrr Wang1rrr commented Oct 8, 2026

Copy link
Copy Markdown

Summary

The README omits eight existing modules, nine capabilities, and most package scripts. Reconcile it with the current source tree and package.json, document development-stage limitations and service requirements, and make the installation and contribution instructions match the repository's current workflow.

Related Issues

Closes #152

Type of Change

  • Documentation only

Changes

  • List all 24 module directories and link the nine missing capabilities to their implementations or existing documentation.
  • Explain current escrow settlement, KYC storage, portfolio valuation, liquidity simulation, and batch rollback limitations instead of presenting them as completed production integrations.
  • Document all 18 scripts, including the five migration scripts, coverage output, and PostgreSQL/Redis requirements for the default Jest integration suite tracked in [Test] Stop npm test from running auth.integration.spec.ts, which needs Postgres and Redis #145.
  • Use npm ci in README and CONTRIBUTING, remove duplicate repository links, and use the current repository URL for cloning and the build badge.
  • Remove the README's internal on-chain-proof comment; the corresponding task already remains in ROADMAP.md.
  • Correct CONTRIBUTING's CI description: the PR workflow runs installation, type checking, and build; lint and tests are also required locally.

Checklist

  • I have read the CONTRIBUTING guide.
  • npm run lint passes.
  • npx tsc --noEmit passes.
  • npm run build succeeds.
  • npm test passes.
  • No application, contract, dependency, or test configuration changes.
  • No secrets or mainnet credentials committed.

Notes for Reviewers

Issue #152 is currently unassigned. This documentation-only proposal is prepared for maintainer review.

Validation used Node.js 20.20.2, matching CI's major version. npm ci, type checking, build, Markdown formatting, the 24-module/18-script inventory checks, relative-link checks, and git diff --check pass.

The following failures also occurred on the untouched upstream main baseline (d4a8f3f):

  • npm run lint -- --no-fix reports 676 existing errors. Auto-fix was disabled to keep this documentation change from rewriting unrelated TypeScript.
  • npm test -- --runInBand reports existing analytics assertion/mock failures, the auth integration suite's missing application configuration, and then terminates on an unhandled ServiceUnavailableException("Queue cleared by administrator") in the request-queue tests. The same failures were reproduced with Node 20 after the documentation edit. No PostgreSQL/Redis environment was provisioned for this documentation task.

The full Jest run did not finish, so this PR does not report a successful full-suite test count. No new tests were added for text changes.

Refs Chulilee#152. Document current capabilities, limitations, script prerequisites, and actual CI checks.
Copilot AI balanced review requested due to automatic review settings October 8, 2026 13:26
@vercel

vercel Bot commented Oct 8, 2026

Copy link
Copy Markdown

@Wang1rrr is attempting to deploy a commit to the Akargi Team on Vercel.

A member of the Team first needs to authorize it.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs] Update the README: 8 modules are missing from Project Structure and 9 from Features

2 participants