mav icon indicating copy to clipboard operation
mav copied to clipboard

make seperate repos for book and sdk.

Open Ben-PH opened this issue 1 year ago • 2 comments
trafficstars

The repo already exists: https://github.com/AeroRust/drones-book

mdbook has some features:

  • config to source url: ideally it should link to a book-specific repo
  • link to suggest-an-edit, for example: https://github.com/rust-lang/mdBook/blob/6f281a6401b2fd83c3f3f61460e0548f2e03ff60/guide/book.toml#L15

In my mind, the drone book is a stand-alone product. It can then be made available to other initiatives such as the mav-sdk project, this repo, or the website. Be that via submodule, CI/CD, etc.

  • [ ] scrape projects for code that link to the drone book directory of this repo and list them here, mark them off as they are migrated
  • [ ] collect issues, PRs, etc. that relate to the book and list here and mark them off as they are migrated
  • [ ] setup drone book as a git submodule to this repo
  • [ ] update CI/CD for site deployment.
  • [ ] ???

Ben-PH avatar Sep 19 '24 10:09 Ben-PH

at the moment separating everything might make it hard for people to find. That's why I've opted for a single repo.

elpiel avatar Sep 22 '24 13:09 elpiel

What about making the book a git submodule?

Ben-PH avatar Sep 22 '24 14:09 Ben-PH

It has to be updated alongside the code which I would like to avoid. Closing this for now.

elpiel avatar Nov 06 '24 09:11 elpiel