You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: Comprehensive README updates across all folders
- Updated main README.md with recovery file feature and improved installation instructions
- Enhanced all folder READMEs with comprehensive documentation:
- src/popup/components/README.md - Complete component documentation
- src/sidepanel/components/README.md - Feed component details
- src/contexts/README.md - Context API usage
- src/offscreen/README.md - Offscreen document architecture
- src/profile/README.md - Profile renderer details
- src/styles/README.md - Styling and Tailwind guide
- src/test/README.md - Test setup and mocks
- src/utils/README.md - Added recovery file and singleton docs
- src/background/README.md - Enhanced with logging and error handling
- src/content/README.md - Added security and memory management
- src/popup/README.md - Added features and keyboard shortcuts
- src/sidepanel/README.md - Added features and performance notes
- src/README.md - Enhanced with entry points and development guide
- icons/README.md - Complete icon documentation
- docs/README.md - Documentation index
All READMEs now include:
- What the folder/project is
- What it can do
- How to use features
- Architecture/technical details
- Code examples
- Related files and links
- Best practices
Copy file name to clipboardExpand all lines: README.md
+41-14Lines changed: 41 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
A powerful Chrome extension that lets you **draw graffiti on web pages**, create text annotations, bookmark URLs, and share everything through the decentralized Pubky network. All your data syncs to your personal Pubky homeserver - no third-party tracking!
-[CHANGELOG.md](../CHANGELOG.md) - Version history
16
89
17
90
## Archive
18
91
19
-
The [archive/](archive/) folder contains historical development notes that were used during development. These are preserved for reference but may be outdated.
92
+
The [archive/](archive/) folder contains:
93
+
- Historical development notes
94
+
- Duplicate files (gitignored)
95
+
- Remnant documentation from development
96
+
97
+
These files are preserved for reference but may be outdated.
98
+
99
+
## Documentation Standards
100
+
101
+
All documentation should:
102
+
- Be clear and concise
103
+
- Include code examples
104
+
- Use proper markdown formatting
105
+
- Be kept up to date
106
+
- Include relevant links
107
+
108
+
## Contributing to Documentation
109
+
110
+
When adding features:
111
+
1. Update relevant documentation files
112
+
2. Add code examples
113
+
3. Update API references
114
+
4. Add to CHANGELOG.md if user-facing
115
+
116
+
## See Also
20
117
118
+
-[Root README](../README.md) - Main project documentation
0 commit comments