ocpp icon indicating copy to clipboard operation
ocpp copied to clipboard

Large rewritting of docs

Open a-alak opened this issue 8 months ago • 5 comments
trafficstars

Not ready for merge! This is a draft/suggestion. Would love your thoughts and feedback.

Changes included in this PR

First draft. Includes a restructuring of the docs setup, addition of multiple doc dependencies (sphinx_inline_tabs, myst_parser, sphinx_copybutton, furo theme), change of theme. Currently the biggest addition is tutorials. The API reference is mostly an AI created draft to get started. Includes suggestions on possible additions (how-to guides and topic guides).

Current behavior

There has been multiple request for updates/expansion of the documentation.

New behavior

Suggesting new documentation theme and a couple of extensions.

Impact

Only changes to the docs.

Checklist

  1. [x] Does your submission pass the existing tests?
  2. [ ] Are there new tests that cover these additions/changes?
  3. [x] Have you linted your code locally before submission?

a-alak avatar Mar 19 '25 19:03 a-alak