Gradually move laser and spacecraft documentation to Elara Handbook #53

songtech-0912 commented 2026年05月04日 10:49:37 +02:00

Right now, Project Elara's documentation is scattered all over the place, with a large amount of documentation for our hardware stuff located outside of the Handbook. This means we don't have a single source of truth and runs contrary to our professed mission that the Elara Handbook contains the comprehensive information about the Project. I would prefer for the documentation (including for the undulator, electron gun, simulations, firmware/firmware app for the laser, and spacecraft computer) to be ported over to the Elara Handbook and that all future additions to the documentation will be on there.

The existing documentation files in the Elara laser research and Elara spacecraft repositories should not be deleted; instead, an archival notice should be placed on them, with a link to the Handbook sections that contain the latest version of the documentation for the specific part(s)/hardware/software.

Note that porting past docs requires agreement among people who have worked on the laser/spacecraft (including theoretical analysis, CAD, hardware, software, etc.), comprising of all of the following people (checked means they agreed to public-domain their work):

• Chris (@Chralv28)
• Maris (@marisw)
• Kuba (@gurinj)
• Felix (@waBoroAsuP)
• Riya (@rjain)
• Aaron (@TaxemicPlace81)
• Bryan (@Bryan_Gelnett)
• Andrew (@anbcodes)
• Nick (@BGND76)
• Zakki (@zsuhu)
• Patrick (@PieFlavoredPie)
• Elyan (@elyanm)

Right now, Project Elara's documentation is scattered all over the place, with a large amount of documentation for our hardware stuff located _outside_ of the Handbook. This means we don't have a single source of truth and runs contrary to our professed mission that the Elara Handbook contains the comprehensive information about the Project. I would prefer for the documentation (including for the undulator, electron gun, simulations, firmware/firmware app for the laser, and spacecraft computer) to be ported over to the Elara Handbook and that all future additions to the documentation will be on there. The existing documentation files in the [Elara laser research](https://codeberg.org/elaraproject/laser-research/) and [Elara spacecraft](https://codeberg.org/elaraproject/elara-spacecraft) repositories should **not** be deleted; instead, an archival notice should be placed on them, with a link to the Handbook sections that contain the latest version of the documentation for the specific part(s)/hardware/software. Note that porting past docs requires agreement among people who have worked on the laser/spacecraft (including theoretical analysis, CAD, hardware, software, etc.), comprising of all of the following people (checked means they agreed to public-domain their work): - [ ] Chris (@Chralv28) - [ ] Maris (@marisw) - [ ] Kuba (@gurinj) - [ ] Felix (@waBoroAsuP) - [x] Riya (@rjain) - [ ] Aaron (@TaxemicPlace81) - [ ] Bryan (@Bryan_Gelnett) - [ ] Andrew (@anbcodes) - [ ] Nick (@BGND76) - [ ] Zakki (@zsuhu) - [x] Patrick (@PieFlavoredPie) - [x] Elyan (@elyanm)

songtech-0912 commented 2026年05月07日 02:47:37 +02:00

Update: currently working on a compromise solution while we get consent for everyone on the list, which is to create a new chapter on the Elara Handbook about how to build the laser/spacecraft without actually using the documentation verbatim. Eventually the existing pages of documentation in the laser/spacecraft repos should be moved to the Handbook's developer guide but this solution works for now.

Update: currently working on a compromise solution while we get consent for everyone on the list, which is to create a new chapter on the Elara Handbook about how to _build_ the laser/spacecraft without actually using the documentation verbatim. Eventually the existing pages of documentation in the laser/spacecraft repos should be moved to the Handbook's [developer guide](https://handbook.elaraproject.org/expert-guide/developer/) but this solution works for now.

songtech-0912 commented 2026年05月07日 07:22:02 +02:00

Also, going forward, I would like new documentation for the Elara spacecraft and laser research repos to be put in the handbook, unless if anyone has objections with making their documentations public domain.

Also, going forward, I would like new documentation for the Elara spacecraft and laser research repos to be put in the handbook, unless if anyone has objections with making their documentations public domain.

songtech-0912 commented 2026年05月07日 07:45:36 +02:00

To make this process easier, can everyone on the list above who agrees to public-domain their work put a comment like I agree to public-domain my work please? It is easiest that way.

To make this process easier, can everyone on the list above who agrees to public-domain their work put a comment like _I agree to public-domain my work_ please? It is easiest that way.

PieFlavoredPie commented 2026年05月07日 22:31:17 +02:00

Go get um
Patrick 👍

Go get um Patrick 👍