search

InfiniTimeOrg / InfiniTime

Firmware for Pinetime smartwatch written in C++ and based on FreeRTOS
GNU General Public License v3.0
2.64k stars 907 forks source link

doc: Reorganization #1688

Open fossison opened 1 year ago

fossison commented 1 year ago

Reorganization of /doc's contents into subdirectories, grouped by use case.

Hey all,

Been using my Pinetime for a few weeks now and would like to start contributing. My first attempt at this is making a first-pass at cleaning up the /doc directory.

I've grouped the existing documentation into three categories:

Open to feedback. I'd like to continue improving documentation beyond this as well (updating user documentation, and adding a "Development with InfiniSim" page). Long-term, standardizing file names, adding indexes, etc.

About me: I've worked in the US tech industry for the past 8 years and have professional experience in Product/Project/Program Management. My programming is mostly hobby-based and spans a number of languages.

minacode commented 1 year ago

Welcome to the community! 😊

fossison commented 1 year ago

I've updated the PR with the following changes:

  1. Updated the markdown syntax of my one list
  2. Reviewed all files and fixed relative linking as needed

Note that the file PinetimeStubWithNrf52DK.md had a previously existing issue where it references a non-existent image.

@Riksu9000 I think that's pretty close to what I envisioned. /ref could in the future include software documentation (for example, if InfiniTime did a graphics abstraction class)

Marking this as ready for review, I should've caught all the broken links this time around.

JF002 commented 1 year ago

Hi and welcome in the community :)

Please note that we've already started a similar initiative here. There haven't been any progress recently, but the goal remains the same : Add user documentation (how to use InfiniTime), update and improve the developer and contributor documentation, and deploy it on https://docs.infinitime.io.

Right now, this PR is mostly outdated, and we should probably work on it step by step instead of trying to move the whole doc at once to the new format.