Skip to content

[P0][README] Modernize the public and private Précis Translator READMEs (Issues disabled) #161

Closed

Description

@EagleFox31

Priority: P0 — public product visibility

Affected repositories: EagleFox31/Pr-cis-Translation (public) and EagleFox31/Precis-Translation (private).

The two repositories expose nearly identical plain text README narratives; GitHub Issues are disabled on both (HTTP 410). This is the canonical documentation task for both until their repository settings change. Do not assume the public repo is the source of truth for implementation.

Deliverable

  • Verify which repository hosts the active application and which is public-facing; reconcile duplicate claims.
  • Write a memorable document-format-fidelity hero, with format badges, demo path and accurate MVP/product status.
  • Add architecture of source layout preservation, translation provider boundaries and supported PDF/DOCX/PPTX/XLSX cases.
  • Use AppFactory reusable README contract, with private repo docs kept private.
  • Adopt a reviewed PR for each affected repo without changing code, hosting or business logic.
  • Validate README QA, GitHub-rendered navigation and consistency between the two repositories.

Reason for central tracking: both consumer repositories have Issues disabled; no admin settings modified.

README modernization program.

Cross-repository tracking: GitHub does not automatically close this central AppFactory Issue when a PR merges in the separately owned target repository. Link the target PR here and close this tracker only after verifying the README change in its actual repository.

Activity

  1. EagleFox31 commented on Oct 26, 2026

    @EagleFox31
    ContributorAuthor

    Both consumer READMEs are now merged and verified on their own default branches:

    Both README contract audits and their required PR CI checks passed. Existing technical content and OCR-as-research boundaries were preserved. Public package.json declares 1.6.2 and private declares 1.1.0, so the documentation explicitly does not equate these repository versions with the live version. The public repository's AWS production workflow targets precis-translator.trigenys.com, while the private repository has its own gated release/version.txt deployment workflow; the currently running SHA was not independently confirmed from the deployment host. No application deployment was performed in this task.

    Central issue closure records completion of the README modernization in both repositories, not certification of the active production deployment.

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions