Skip to content

Reconcile starter documentation with files that actually ship #12

Description

@koniz-dev

Context

Several committed guides present non-existent starter files as usable APIs: hooks/README.md and docs/color-themes.md reference hooks/useThemeColor.ts; components/README.md references ThemedText.tsx and ThemedView.tsx; and scripts/README.md documents scripts/reset-project.js, which is not committed. This makes a fresh starter checkout misleading.

Acceptance criteria

  1. Every documented local file import or script command in README files and docs/ resolves to a committed file, or is explicitly marked as an optional create-it-yourself example with complete creation steps.
  2. The docs accurately describe the shipped Paper theme and loading/error components.
  3. A repository check (automated where practical) verifies local Markdown links and code-path references in the corrected scope.
  4. npm run format:check passes.

Activity

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

Metadata

Metadata

Assignees

Labels

epic:docsREADME, docs/, per-directory guidespriority:P2Normal prioritystatus:in-progressClaimed; assignee is actively workingtaskChore, refactor, or maintenance work

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions