Documentation (for launch)

[umgefahren]

We have started working on documentation on: https://github.com/p2p-industries/docs

Here are the TODOs

• Quick Start
• Concepts
  • Algorithms
  • Design Goals
• Example
  • Minimal
  • Robot
    • ROS
    • w/o ROS
  • Garden
• FAQ
• Troubleshooting

[lk-eg]

• start with installation

pip
cargo
java script

• quick start
• What is HyveOS: explain more, show use cases
• verifying that it works
• SDK Reference in SDK umbenennen
• change ordering of sdk services
• [optional] Hello World also for Rust
• tutorial: user uses file transfer and gossip sub to build a kind of twitter clone. Use React as a frontend library.
• video streaming: HLS

[lk-eg]

• Landing page needs a rehaul: installation bash commands, different background design, HyveOS logo. Take inspiration from Tauri
• ADD A ROBOTICIST SIDE TUTORIAL: Think it from the side of a roboticist!!!

[lk-eg]

After-launch tutorials in the pipeline:

• Local Twitter Clone: instant broadcast network. Make many nodes share content in the form of images, sensor data, etc. to shared topics
• control / consensus - leader election / path planning

[lk-eg]

We need to add diagrams / graphics. Not top priority, can wait for after the launch. But afterwards, we need them asap