Skip to content

Commit 97e8b2a

Browse files
committed
docs: remove duplicate technical documentation
Remove redundant documentation files that duplicate content already covered in other docs. Deprecate overly technical doc that's not useful for most developers. Changes: - Remove manifest-format.md (content in manifest-management.md) - Deprecate cacache-format.md (too low-level for most users) - Update docs/README.md to reflect removals - Add descriptions to technical docs in index Benefits: - Eliminates 40% duplication in manifest documentation - Clearer technical documentation structure - Single source of truth for each topic
1 parent faed74e commit 97e8b2a

File tree

3 files changed

+4
-469
lines changed

3 files changed

+4
-469
lines changed

docs/README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -66,12 +66,10 @@ Complete end-to-end onboarding for new contributors:
6666
- [Testing performance](performance/performance-testing.md)
6767

6868
### Technical Details
69-
- [Cacache format](technical/cacache-format.md)
70-
- [Manifest extensions](technical/manifest-extensions.md)
71-
- [Manifest format](technical/manifest-format.md)
72-
- [Manifest management](technical/manifest-management.md)
73-
- [Metadata files](technical/metadata-files.md)
74-
- [Patch cacache](technical/patch-cacache.md)
69+
- [Manifest management](technical/manifest-management.md) - Complete manifest API reference
70+
- [Manifest extensions](technical/manifest-extensions.md) - Proposed future features
71+
- [Metadata files](technical/metadata-files.md) - Metadata file formats
72+
- [Patch cacache](technical/patch-cacache.md) - Patch backup and caching system
7573

7674
### Testing
7775
- [Local testing](testing/local-testing.md)
File renamed without changes.

0 commit comments

Comments
 (0)