mirror of
https://github.com/praktimarc/kst4contest.git
synced 2026-08-26 03:57:16 +02:00
chore: add Codex project context and agent guidance
This commit is contained in:
@@ -0,0 +1,26 @@
|
||||
# User-facing feature context
|
||||
|
||||
This is a documentation coverage reminder, not a canonical feature list. Verify each item in current code before documenting it.
|
||||
|
||||
Areas repeatedly documented or changed include:
|
||||
|
||||
- simultaneous ON4KST chat categories;
|
||||
- priority candidates;
|
||||
- sked timeline/reminders;
|
||||
- known active bands / B+ / NOT-QRV;
|
||||
- worked indicators;
|
||||
- DXCluster;
|
||||
- AirScout integration;
|
||||
- map/path analysis;
|
||||
- filtering and reachability;
|
||||
- PSTRotator/rotor integration;
|
||||
- UCXLog/DXLog and Win-Test log synchronization;
|
||||
- beacon/autoanswer behaviour;
|
||||
- connection status/reconnect behaviour;
|
||||
- dark/light UI behaviour;
|
||||
- QTF/bearing workflow;
|
||||
- download/update behaviour.
|
||||
|
||||
When one of these changes, search both language manuals and website copy for affected references.
|
||||
|
||||
Do not specialize documentation beyond actual behaviour. A useful example from prior work is callsign monitoring: entering an SSID-style variant can intentionally monitor the base call rather than requiring every suffix to be configured individually.
|
||||
@@ -0,0 +1,47 @@
|
||||
# Manual and website context
|
||||
|
||||
## Manual location
|
||||
|
||||
KST4Contest documentation is maintained in `github_docs/` with English and German Markdown pages plus screenshots.
|
||||
|
||||
The documentation build is automated through repository workflows.
|
||||
|
||||
## Audit workflow established with Marc
|
||||
|
||||
The normal review method is:
|
||||
|
||||
1. compare documentation with actual code/behaviour;
|
||||
2. propose exact changes;
|
||||
3. note missing/outdated screenshots and their intended repo location;
|
||||
4. if code must change to match the manual, stop and confirm that code change first;
|
||||
5. keep German and English content aligned;
|
||||
6. prefer one thorough update over many cosmetic iterations.
|
||||
|
||||
With Codex editing locally, the old copy/paste insertion-guide step is replaced by direct edits, but the approval logic remains.
|
||||
|
||||
## Examples and easter eggs
|
||||
|
||||
Deliberate examples/test strings must not be "cleaned up" merely because they are informal.
|
||||
|
||||
A known example uses:
|
||||
|
||||
```text
|
||||
DO5AMF
|
||||
Testing DXC-Spot: Congrats, you donated $100!
|
||||
```
|
||||
|
||||
Preserve such deliberate easter eggs unless Marc explicitly asks to remove or replace them.
|
||||
|
||||
## Website
|
||||
|
||||
The website under `website/` uses Eleventy/Nunjucks.
|
||||
|
||||
Style direction:
|
||||
|
||||
- modern and concise;
|
||||
- technically focused;
|
||||
- no promotional tone;
|
||||
- English primary where appropriate;
|
||||
- documentation remains the detailed source; website text should not duplicate entire manual sections.
|
||||
|
||||
Current website architecture/scripts must be inspected before changes.
|
||||
@@ -0,0 +1,35 @@
|
||||
# Release communications
|
||||
|
||||
## Changelog
|
||||
|
||||
Write concise English change descriptions.
|
||||
|
||||
Prioritize:
|
||||
|
||||
- behaviour users notice;
|
||||
- contest workflow impact;
|
||||
- protocol/integration compatibility;
|
||||
- bug/reliability fixes;
|
||||
- documentation improvements.
|
||||
|
||||
Avoid internal refactor trivia unless it materially changes reliability or maintainability relevant to the release.
|
||||
|
||||
## Social release post
|
||||
|
||||
Use `$praktimarc-writing-style`.
|
||||
|
||||
Typical structure:
|
||||
|
||||
- version;
|
||||
- short statement of what the release contains;
|
||||
- compact highlights;
|
||||
- operational context where relevant, e.g. preparation for a VUSHF contest or planned use at DM5M;
|
||||
- one clear download/manual destination.
|
||||
|
||||
Do not oversell.
|
||||
|
||||
## Download/manual direction
|
||||
|
||||
Marc has preferred routing users to the HamRadioOnline/KST4Contest download/manual pages rather than scattering multiple download links.
|
||||
|
||||
Before publishing new text, inspect the current website URLs and release setup instead of copying an old link.
|
||||
Reference in New Issue
Block a user