Skip to content

[nightshift] doc-drift: documentation out of sync with code #1

@nightshift-micr

Description

@nightshift-micr

Documentation Drift Report: micr-dev/proyectos

Summary

Analyzed the micr-dev/proyectos codebase — a Next.js 16 portfolio site that renders project descriptions from structured TypeScript data files. Cross-referenced all documentation sources against the actual code.

Total issues found: 12 | P0: 1 | P1: 2 | P2: 5 | P3: 4


P0 Critical — Documentation actively misleading

1. m-d/proyectos missing from repo-images.ts — portfolio entry renders generic placeholder

  • File: app/repo-images.ts (missing entry for key "m-d/proyectos")
  • Related: REPO.md line 23, app/repo-metadata.ts lines 183–188
  • Impact: The m-d/proyectos entry exists in REPO.md, has metadata and a description, but has no image mapping in repo-images.ts. At runtime, getRepoImage() falls back to a stale placeholder image from /images/oct25Coll/skiperpro/shoreel-*.png — an unrelated collection from October 2025.
  • Fix: Add "m-d/proyectos": "proyectos.webp" to the repoImages map, and create the corresponding public/images/repo-thumbnails/proyectos.webp file.

P1 High — Missing docs for public-facing features

2. kagi-mcp mapped to wrong thumbnail — dedicated image exists but unused

  • File: app/repo-images.ts line 37: "kagi-mcp": "kagi-cli.webp"
  • Evidence: File public/images/repo-thumbnails/kagi-mcp.webp exists on disk but is never referenced
  • Fix: Change to "kagi-mcp": "kagi-mcp.webp" in repo-images.ts.

3. No README.md — zero onboarding documentation

  • Missing file: README.md
  • Impact: No documentation on how to install, develop, build, deploy, or understand the architecture.
  • Fix: Create a README.md covering setup, architecture, data flow, and the content authoring workflow.

P2 Medium — Stale references, outdated version numbers

4. bolify description references "DaVinci Resolve 20+" — version does not exist

  • File: app/repo-copy-batches/software-a.ts line 38
  • Fix: Verify the actual minimum required version and correct to "DaVinci Resolve 19+" or appropriate version.

5. chatgpt-webui-mcp description references "GPT-5.2 Pro" — verify model existence

  • File: app/repo-copy-batches/mcps-skills.ts line 22
  • Fix: Verify the model is real and update if needed.

6. DESCRIPTION.md written in English but site renders in Spanish

  • File: DESCRIPTION.md
  • Fix: Add a note clarifying that all description copy must be in Spanish.

7. Unused thumbnail file kagi-mcp.webp orphaned on disk

8. Placeholder images reference stale oct25Coll path

  • File: app/repo-images.ts lines 2–5
  • Fix: Create a proper proyectos.webp thumbnail or update placeholder paths.

P3 Low — Minor formatting inconsistencies

9. Trailing comma inconsistency in description batch files

10. No JSDoc or inline comments on any component

11. skiper80.tsx local RepoItem interface duplicates repo-sections.ts type

12. Display name vs. repo name mismatches undocumented


Automated by Nightshift v3 (GLM 5.1) — merge if useful, close if not.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions