30 lines
1.4 KiB
Plaintext
30 lines
1.4 KiB
Plaintext
|
[ Documentation Update ]
|
||
|
|
The project needs a proper html developer documentation.
|
||
|
|
It will get an html documentation that will be readable for the human and agent developers (replacing claude.md)
|
||
|
|
|
||
|
|
It will get its first index.html in "doc/outline/index.html" in the root path.
|
||
|
|
|
||
|
|
It will contain the entry point for the agent to ensure it is on track.
|
||
|
|
|
||
|
|
|
||
|
|
It contains the following paragraphs:
|
||
|
|
|
||
|
|
- project outline:
|
||
|
|
Explains what the project is about (high level short), what it does (currently), and what is should do (todos for the ).
|
||
|
|
|
||
|
|
- technical implementation:
|
||
|
|
Explains the tech stack, includes a link to the coding guidelines "doc/outline/coding-guidelines",
|
||
|
|
which should be copied from https://rokojori.com/en/labs/rokojori-action-library/coding-guidelines.
|
||
|
|
|
||
|
|
- actions:
|
||
|
|
Contains a set of tasks that are used repeatadly. It should contain for each action a short summary
|
||
|
|
what it does. The first two actions are:
|
||
|
|
|
||
|
|
Update History:
|
||
|
|
This action updates what was done in the last session of the day. It should create an entry for the day the session started
|
||
|
|
and use the "history/styles.css" to create an html document. An example path for the 4th July is "history/2026/07-July/04-Saturday"
|
||
|
|
It should also update the main "history/index.html", which contains a list of all history entries. On every update this file is updated.
|
||
|
|
|
||
|
|
Update Documentation:
|
||
|
|
This action updates the documentation, by updating the project outline and maybe more things for the documentation.
|