#Documentation in Vitepress

15 messages · Page 1 of 1 (latest)

summer trellis
#

I talked before about looking into the docs, there was some good reception, and with the docs source released it's time to dive in!

The plan is:

  1. Look into existing code
    2. Try to make it build (done by @pine flume )
    3. Check need/advantages/feasibility of migrating to a new system (Mkdocs sounded like a winner when I started discussion in the past and after some reading)
  2. If yes, go! -~~ Experiment with Mkdocs~~
pine flume
#

i've done 2 already, just havent pushed that work anywhere - if that would be helpful to you, let me know and i can throw it up somewhere!

summer trellis
pine flume
#

there's a nix development shell you can jump into with nix develop if you have that installed, and there's a docker container that will serve the built site

#

(also note that site search does not work)

pine flume
#

quick update: the repo is now in the pebble-dev org

summer trellis
#

Documentation in Mkdocs

summer trellis
#

Documentation in Vitepress

#

Mkdocs was consuming too much time and looking like some stuff would be too complex to make - pivoted to Vitepress.
Sample screen following.

summer trellis
#

https://joaopluis.github.io/rebble-vitepress/
Working link, still very much a WIP. Using MD files from the repo as a base, already replaced the screenshot viewer and platform parts. Tutorials are almost all there, SDK is in progress.
Not taking design too much into consideration, using default theme and its components. The whole thing can easily be fully redesigned without affecting content.

Rebble Developer

Pebble Developer Documentation

summer trellis
#

Quick update, if someone is following 😂
I have the SDK basics done - updated from Rebble help - and some guides. Guides are easy to update, just need to replace some stuff with the new syntax.
Currently looking into the Doxygen situation for the C docs. Been able to go .h -> XML - > nice JSON. Idea is to build a simple script to parse this JSON into the Markdown files & structure that is needed.
I plan to continue putting work to this, but unfortunately I am not having as much time as I wanted 😦 I'll send by the end of the hackathon and continue working 🙂

main terrace
#

Wow this is really cool, I hope this can be the basis for the docs going forward, it feels like much nicer UX

summer trellis
#

Just pushed a version with some Guides and an initial version of the C docs. Don't really like it, will change to parsing the XML directly. Am I crazy? Probably yes, but I already knew that.
Will submit the form, and will keep working on this. Next thing to do is still the C docs.