Skip to content

Commit cd40f02

Browse files
author
Scott Senkeresty
committed
fix: Update references after docs consolidation
- Update help:// adapter STATIC_HELP to point to consolidated files - Add new topics: recipes, codebase-review, output - Fix README.md link text (COOL_TRICKS → RECIPES) - Fix TOC anchor format in RECIPES.md and CODEBASE_REVIEW.md - Update packaging test (AGENT_HELP_FULL.md merged into AGENT_HELP.md) - Remove stale build/ artifacts Fixes issues found during validation of spectral-hacker-0119 consolidation.
1 parent 9292da3 commit cd40f02

File tree

5 files changed

+23
-25
lines changed

5 files changed

+23
-25
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -486,7 +486,7 @@ reveal/
486486
**Quality metrics:** 2,500+ tests, continuous integration on every commit.
487487
488488
**Documentation:** [reveal/docs/README.md](reveal/docs/README.md) - Comprehensive guides for users, developers, and AI agents
489-
**Power users:** [COOL_TRICKS.md](reveal/docs/RECIPES.md) - Hidden features and advanced workflows
489+
**Power users:** [RECIPES.md](reveal/docs/RECIPES.md) - Task-based workflows and advanced patterns
490490
491491
---
492492

reveal/adapters/help.py

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,19 +64,21 @@ class HelpAdapter(ResourceAdapter):
6464
STATIC_HELP = {
6565
'quick-start': 'QUICK_START.md', # 5-minute quick start guide
6666
'agent': 'AGENT_HELP.md',
67-
'agent-full': 'AGENT_HELP_FULL.md',
67+
'agent-full': 'AGENT_HELP.md', # Alias (full version merged into AGENT_HELP.md)
6868
'python': 'PYTHON_ADAPTER_GUIDE.md', # Alias for python-guide
6969
'python-guide': 'PYTHON_ADAPTER_GUIDE.md',
7070
'reveal-guide': 'REVEAL_ADAPTER_GUIDE.md', # Reference implementation
7171
'markdown': 'MARKDOWN_GUIDE.md',
7272
'html': 'HTML_GUIDE.md', # HTML features guide
73-
'anti-patterns': 'ANTI_PATTERNS.md',
73+
'anti-patterns': 'AGENT_HELP.md', # Merged into AGENT_HELP.md
7474
'adapter-authoring': 'ADAPTER_AUTHORING_GUIDE.md',
75-
'tricks': 'COOL_TRICKS.md',
75+
'tricks': 'RECIPES.md', # Merged into RECIPES.md (task-based workflows)
76+
'recipes': 'RECIPES.md', # Primary name for workflow recipes
7677
'help': 'HELP_SYSTEM_GUIDE.md', # Meta-documentation about help system
7778
'configuration': 'CONFIGURATION_GUIDE.md', # Configuration system guide
7879
'config': 'CONFIGURATION_GUIDE.md', # Alias for configuration
79-
'release': 'RELEASE_GUIDE.md', # Release process for maintainers
80+
'codebase-review': 'CODEBASE_REVIEW.md', # Codebase review workflows
81+
'output': 'OUTPUT_CONTRACT.md', # Output format contract
8082
'schemas': 'SCHEMA_VALIDATION_HELP.md', # Schema validation guide (v0.29.0+)
8183
'duplicates': 'DUPLICATE_DETECTION_GUIDE.md', # Duplicate code detection guide
8284
'duplicate-detection': 'DUPLICATE_DETECTION_GUIDE.md' # Alias for duplicates

reveal/docs/CODEBASE_REVIEW.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@ Reveal is a **semantic code exploration tool** that enables comprehensive codeba
1717

1818
## Table of Contents
1919

20-
1. [The 14 Adapters: Your Review Toolkit](#the-13-adapters-your-review-toolkit)
20+
1. [The 14 Adapters: Your Review Toolkit](#the-14-adapters-your-review-toolkit)
2121
2. [Core Review Workflows](#core-review-workflows)
2222
3. [The Complete Codebase Review Process](#the-complete-codebase-review-process)
2323
4. [Advanced Multi-Adapter Patterns](#advanced-multi-adapter-patterns)
24-
5. [Quality Gates & Metrics](#quality-gates--metrics)
24+
5. [Quality Gates & Metrics](#quality-gates-metrics)
2525
6. [Token-Efficient AI Review Strategies](#token-efficient-ai-review-strategies)
2626
7. [Real-World Review Scenarios](#real-world-review-scenarios)
2727
8. [Quick Reference](#quick-reference)

reveal/docs/RECIPES.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ Find your task, get the commands. This guide organizes reveal by workflow, not b
99
## Table of Contents
1010

1111
- [Code Review](#code-review)
12-
- [Onboarding & Exploration](#onboarding--exploration)
13-
- [Debugging & Troubleshooting](#debugging--troubleshooting)
14-
- [Refactoring & Quality](#refactoring--quality)
12+
- [Onboarding & Exploration](#onboarding-exploration)
13+
- [Debugging & Troubleshooting](#debugging-troubleshooting)
14+
- [Refactoring & Quality](#refactoring-quality)
1515
- [Documentation Maintenance](#documentation-maintenance)
1616
- [JSON Navigation](#json-navigation)
1717
- [Database Operations](#database-operations)

tests/test_packaging_manifest.py

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -45,29 +45,25 @@ def tearDownClass(cls):
4545
shutil.rmtree(cls.temp_dir, ignore_errors=True)
4646

4747
def test_agent_help_files_included(self):
48-
"""AGENT_HELP*.md files must be included in distribution.
49-
50-
Regression test: These files were moved to reveal/docs/ but MANIFEST.in
51-
still referenced reveal/AGENT_HELP*.md, causing them to be excluded.
48+
"""AGENT_HELP.md must be included in distribution.
49+
50+
Regression test: This file was moved to reveal/docs/ but MANIFEST.in
51+
still referenced reveal/AGENT_HELP*.md, causing it to be excluded.
52+
Note: AGENT_HELP_FULL.md was merged into AGENT_HELP.md in v0.39.0.
5253
"""
5354
with tarfile.open(self.tarball, 'r:gz') as tar:
5455
names = tar.getnames()
55-
56-
# Check for both agent help files
56+
57+
# Check for agent help file
5758
agent_help = [n for n in names if 'AGENT_HELP.md' in n]
58-
agent_help_full = [n for n in names if 'AGENT_HELP_FULL.md' in n]
59-
59+
6060
self.assertTrue(
6161
len(agent_help) > 0,
6262
"AGENT_HELP.md not found in package! Check MANIFEST.in"
6363
)
64-
self.assertTrue(
65-
len(agent_help_full) > 0,
66-
"AGENT_HELP_FULL.md not found in package! Check MANIFEST.in"
67-
)
68-
69-
# Verify they're in the correct location
70-
for name in agent_help + agent_help_full:
64+
65+
# Verify it's in the correct location
66+
for name in agent_help:
7167
self.assertIn(
7268
'/reveal/docs/',
7369
name,

0 commit comments

Comments
 (0)