Adwave Content READ ONLY dev@local

← Documents

Documentation Gaps - Living Document

strategy/documentation-gaps.md · strategy · 1 versions

Documentation Gaps - Living Document

Purpose: Track known gaps in documentation that could block or confuse future work.
Last Updated: December 19, 2025

---

Resolved Issues

The following gaps have been addressed:

GapResolutionDate
Contentful configuration constantsAdded to agent-context.md and publishing-guide.md2025-12-08
Complete end-to-end checklistCreated stat-snapshot-qc-checklist.md2025-12-17
Nano-banana output locationDocumented in publishing-guide.md2025-12-08
Tail line calculation fixCorrected formula in publishing-guide.md2025-12-08
Publishing guide missing brief stepAdded "Read Brief" step2025-12-08
Writing rules not referencedAdded references to .cursor/rules/2025-12-08
Sitemap fetch methodDocumented firecrawl_map usage2025-12-08
Image count per content typeAdded to agent-context.md and formatting rules2025-12-08
Tool verification sectionAdded to publishing-guide.md2025-12-08
Social media documentation fragmentedConsolidated 7 files into 22025-12-19
Duplicate competitor content fileRemoved competitor-content-update.md2025-12-19
Document hierarchy unclearAdded 3-layer hierarchy to agent-context.md2025-12-19

---

Open Gaps

Priority: High

1. Industry Type Field Mismatch

Problem: The industryType values in Contentful don't fully match the taxonomy document.

Contentful accepts (validated):

Taxonomy document lists (19 industries):

Solution needed: Either update Contentful field validations OR update taxonomy document to match Contentful.

---

2. Error Recovery Procedures

Problem: No documentation on what to do if publishing fails partway through.

Scenarios to document:

Solution needed: Add troubleshooting section with recovery steps for common failure modes.

---

Priority: Medium

3. Draft Status Tracking

Problem: No consistent way to track brief → draft → published status.

Current state:

Solution needed: Standardize status tracking (e.g., add status field to brief metadata).

---

4. Published Entry ID Tracking

Problem: Entry IDs are tracked inconsistently.

Solution needed:

---

5. Tool Unavailability Fallbacks

Problem: Documentation assumes MCP tools are always available but doesn't explain fallbacks.

Affected tools:

Solution needed: For each tool, document:

---

Priority: Low

6. Locale Handling

Problem: All content uses en-US but this isn't explicitly documented everywhere.

Solution needed: Document in publishing guide that all fields use en-US locale.

---

7. RichText Edge Cases

Problem: Some RichText conversion gotchas aren't documented.

Known issues:

Solution needed: Document known conversion limitations.

---

How to Use This Document

  1. Before starting work: Check if any open gaps affect your task
  2. After discovering issues: Add them here with priority
  3. After resolving gaps: Move to "Resolved" section with date
  4. Quarterly: Review open gaps and prioritize fixes

---

Change Log

DateChange
2025-12-19Major cleanup: Moved 12 items to resolved, consolidated remaining gaps by priority
2025-12-08Added Dec 2025 session discoveries (gaps 16-22)
2025-12-08Initial creation

Version history