storm/bifrost
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Documentation updates.

Browse Source
This commit is contained in:
Storm Dragon
2025-07-20 21:53:01 -04:00
parent 31314764bf
commit 352bea6ec7
2 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
CLAUDE.md
View File

@@ -7,6 +7,12 @@ Bifrost is a fully accessible fediverse client built with PySide6, designed spec
- Check for any changes in git project before doing anything else. Make sure the latest changes have been pulled - Check for any changes in git project before doing anything else. Make sure the latest changes have been pulled
- See what has changed, use git commands and examine the code to make sure you are up to date with the latest code - See what has changed, use git commands and examine the code to make sure you are up to date with the latest code
## Documentation and Dependencies
- **README Updates**: When adding new functionality or sound events, update README.md with detailed descriptions
- **Requirements Management**: Check and update requirements.txt when new dependencies are added
- **Sound Pack Documentation**: Document new sound events in both CLAUDE.md and user-facing documentation
- **Version Tracking**: Update version numbers and changelog when significant features are added
## Core Features ## Core Features
- Full ActivityPub protocol support (Pleroma and GoToSocial primary targets) - Full ActivityPub protocol support (Pleroma and GoToSocial primary targets)
- Threaded conversation navigation with collapsible tree view - Threaded conversation navigation with collapsible tree view

4
README.md
View File

@@ -137,6 +137,8 @@ Your sound pack should include audio files for these events:
- `post_sent` - User successfully posted - `post_sent` - User successfully posted
- `timeline_update` - New posts in timeline - `timeline_update` - New posts in timeline
- `notification` - General notification - `notification` - General notification
- `autocomplete` - Autocomplete suggestions available (optional)
- `autocomplete_end` - Autocomplete interaction ended (optional)
- `startup` - Application started (optional) - `startup` - Application started (optional)
- `shutdown` - Application closing (optional) - `shutdown` - Application closing (optional)
- `expand` - Thread expanded (optional) - `expand` - Thread expanded (optional)
@@ -162,6 +164,8 @@ Create a `pack.json` file with this format:
"post_sent": "sent.wav", "post_sent": "sent.wav",
"timeline_update": "update.wav", "timeline_update": "update.wav",
"notification": "notification.wav", "notification": "notification.wav",
"autocomplete": "autocomplete.wav",
"autocomplete_end": "autocomplete_end.wav",
"startup": "startup.wav", "startup": "startup.wav",
"shutdown": "shutdown.wav", "shutdown": "shutdown.wav",
"expand": "expand.wav", "expand": "expand.wav",