wagesj45/Sortana
1
0
Fork 0
Code Issues Pull requests Projects Releases 5 Packages Wiki Activity Actions

Merge pull request #85 from wagesj45/codex/update-readme.md-and-agents.md

Browse source 
Update README and AGENTS docs
This commit is contained in:
Jordan Wages 2025-07-08 21:59:51 -05:00 • committed by GitHub
commit 2a31b02039
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 8 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

9
AGENTS.md
View file

@ -5,8 +5,9 @@ This file provides guidelines for codex agents contributing to the Sortana proje
## Repository Overview ## Repository Overview
- `background.js`: Handles startup tasks and coordinates message passing within the extension. - `background.js`: Handles startup tasks and coordinates message passing within the extension.
- `modules/`: Contains reusable JavaScript modules such as `AiClassifier.js`. - `modules/`: Contains reusable JavaScript modules such as `AiClassifier.js`,
- `options/`: The options page HTML, JavaScript and Bulma CSS. `defaultParams.js` and `themeUtils.js`.
- `options/`: The options page HTML, JavaScript and bundled Bulma CSS (v1.0.3).
- `details.html` and `details.js`: View AI reasoning and clear cache for a message. - `details.html` and `details.js`: View AI reasoning and clear cache for a message.
- `resources/`: Images and other static files. - `resources/`: Images and other static files.
- `prompt_templates/`: Prompt template files for the AI service. - `prompt_templates/`: Prompt template files for the AI service.
@ -41,7 +42,7 @@ Additional documentation exists outside this repository.
- Thunderbird Add-on Store Policies - Thunderbird Add-on Store Policies
- [Third Party Library Usage](https://extensionworkshop.com/documentation/publish/third-party-library-usage/) - [Third Party Library Usage](https://extensionworkshop.com/documentation/publish/third-party-library-usage/)
- Third Party Libraries - Third Party Libraries
- [Bulma.css](https://github.com/jgthms/bulma) - [Bulma.css v1.0.3](https://github.com/jgthms/bulma/blob/1.0.3/css/bulma.css)
- Issue tracker: [Thunderbird tracker on Bugzilla](https://bugzilla.mozilla.org/describecomponents.cgi?product=Thunderbird) - Issue tracker: [Thunderbird tracker on Bugzilla](https://bugzilla.mozilla.org/describecomponents.cgi?product=Thunderbird)
@ -71,5 +72,5 @@ time the add-on loads after an update.
Toolbar and menu icons reside under `resources/img` and are provided in 16, 32 Toolbar and menu icons reside under `resources/img` and are provided in 16, 32
and 64 pixel variants. When changing these icons, pass a dictionary mapping the and 64 pixel variants. When changing these icons, pass a dictionary mapping the
sizes to the paths in `browserAction.setIcon` or `messageDisplayAction.setIcon`. sizes to the paths in `browserAction.setIcon` or `messageDisplayAction.setIcon`.
Use `resources/svg/svg2img.ps1` to regenerate PNGs from the SVG sources. Use `resources/svg2img.ps1` to regenerate PNGs from the SVG sources.

6
README.md
View file

@ -59,12 +59,12 @@ Sortana is implemented entirely with standard WebExtension scripts—no custom e
1. Ensure PowerShell is available (for Windows) or adapt the script for other 1. Ensure PowerShell is available (for Windows) or adapt the script for other
environments. environments.
2. Ensure the Bulma stylesheet (v1.0.4) is saved as `options/bulma.css`. You can 2. The Bulma stylesheet (v1.0.3) is already included as `options/bulma.css`.
download it from <https://github.com/jgthms/bulma/blob/1.0.4/css/bulma.css>.
3. Run `powershell ./build-xpi.ps1` from the repository root. The script reads 3. Run `powershell ./build-xpi.ps1` from the repository root. The script reads
the version from `manifest.json` and creates an XPI in the `release` folder. the version from `manifest.json` and creates an XPI in the `release` folder.
4. Install the generated XPI in Thunderbird via the Add-ons Manager. During 4. Install the generated XPI in Thunderbird via the Add-ons Manager. During
development you can also load the directory as a temporary add-on. development you can also load the directory as a temporary add-on.
5. To regenerate PNG icons from the SVG sources, run `resources/svg2img.ps1`.
## Usage ## Usage
@ -124,7 +124,7 @@ requires disclosure of third party libraries that are included in the add-on. Ev
the disclosure is only required for add-on review, they'll be listed here as well. Sortana the disclosure is only required for add-on review, they'll be listed here as well. Sortana
uses the following third party libraries: uses the following third party libraries:
- [Bulma.css v1.0.4](https://github.com/jgthms/bulma/blob/1.0.4/css/bulma.css) - [Bulma.css v1.0.3](https://github.com/jgthms/bulma/blob/1.0.3/css/bulma.css)
- MIT License - MIT License
- [turndown v7.2.0](https://github.com/mixmark-io/turndown/tree/v7.2.0) - [turndown v7.2.0](https://github.com/mixmark-io/turndown/tree/v7.2.0)
- MIT License - MIT License