New EVerest documentation #1591
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
movhdi
reviewed
Nov 29, 2025
3 tasks
Pietfried
force-pushed
the
feature/docs-migration
branch
from
8d0bce3 to
78eeca2
Compare
cburandt
reviewed
Dec 11, 2025
|
|
||
| get-started-sw | ||
| get-started-hw | ||
| /explanation/adapt-everest/index |
Contributor
There was a problem hiding this comment.
This makes adapt-everest appear in the index for the second time (once below explanation and now also under explanation/getting-started)
Contributor
There was a problem hiding this comment.
Some modules link to yaml files (like this one to manifest <../manifest.yaml>_.) - this does not work in the generated docs.
Comment on lines
34
to
40
| .. grid-item-card:: 🔌 EVerest APIs | ||
| :link: /explanation/adapt-everest/index | ||
| :link-type: doc | ||
|
|
||
| Learn about the APIs provided by EVerest that help you integrating | ||
| EVerest into your system and adapting it to your needs. | ||
|
|
Contributor
There was a problem hiding this comment.
This links to both, EVerest APIs and Sub-Systems - change link name&explanation or remove the link (since it's linked on a higer level in the toc anyways)
Contributor
Author
There was a problem hiding this comment.
I would like the APIs to be highlighted in the GettingStarted section. Removed it from the toctree
Contributor
There was a problem hiding this comment.
Remove index.rst for all BU modules or create them for each one?
Contributor
Author
There was a problem hiding this comment.
Created it for all BU modules
Contributor
There was a problem hiding this comment.
Linked on the top-level index.rst, but not part of the TOC?
| Select PWM off / X1, switch EV simulator to state A. | ||
| This should output constant +12 V on the CP line. | ||
|
|
||
| - ☐ Select AC coupling on the scope and verify the ripple noise. There |
Contributor
There was a problem hiding this comment.
These boxes look awkward (here and in some other rst files). I think, dynamic checkboxes are not possible in the resulting html.
Contributor
Author
There was a problem hiding this comment.
Agreed, just using simple bullets now
| We provide several entry points for a fast start with EVerest. | ||
| Whether you want to do a software-based simulation or start | ||
| working with existing hardware, you will find your way here. | ||
|
|
Contributor
There was a problem hiding this comment.
This is the only subpage with grid-itme-cards - on purpose?
Contributor
Author
There was a problem hiding this comment.
It would probably be nice to have it for subpages explanation, how-to-guides, and tutorials as well.
| .. tip:: | ||
|
|
||
| You can download an SDK for the phyVERSO board here: | ||
| [SDK BaseCamp/phyVERSO](http://pionix-update.de/phyverso/1.0.0/phytec-ampliphy-rauc-glibc-x86_64-phyverso-basecamp-image-aarch64-toolchain-BSP-Yocto-Ampliphy-AM62x-PD23.2.1-phyVERSO-EVCS.sh). |
Contributor
There was a problem hiding this comment.
since it's a link, it got to be what it is, but still a bit unfortunate that it uses "basecamp"
Contributor
Author
There was a problem hiding this comment.
It was still a markdown link, fixed it.
| ############################################## | ||
|
|
||
| To get more information on EVerest and Renesas hardware, see here: | ||
| https://www.renesas.com/en/products/microcontrollers-microprocessors/rz-mpus/rz-partner-solutions/pionix-basecamp |
Contributor
There was a problem hiding this comment.
a bit unfortunate that it uses "basecamp" in the link
…tory. (#1380) It is the foundation for the integration of more documentation bits from https://github.com/EVerest/EVerest into this structure. Changes include: * Docs build process and Sphinx configuration * Diataxis skeleton dividing every part of the documentation into: Explaination, How-to-guide, Tutorial, Reference * Added instructions how to build the documentation to everest-core README * Generation of reference documentation Signed-off-by: Krealyt <manuel.ziegler@pionix.de> Signed-off-by: Andreas Heinrich <andreas.heinrich@rwth-aachen.de> Signed-off-by: Piet Gömpel <pietgoempel@gmail.com> Co-authored-by: Piet Gömpel <37657534+Pietfried@users.noreply.github.com>
* doc(explanation): Add community channels to docs Signed-off-by: Piet Gömpel <pietgoempel@gmail.com> --------- Signed-off-by: Piet Gömpel <pietgoempel@gmail.com> Co-authored-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
…inx (#1477) * Refactor _find_sphinx_build macro to allow system installation of sphinx Signed-off-by: Andreas Heinrich <andreas.heinrich@rwth-aachen.de> * Fix setting of _SPHINX_BUILD_EXECUTABLE It needs to be a list, otherwise cmake will escape all whitespace which would then lead to a failure executing the command Signed-off-by: Kai-Uwe Hermann <kai-uwe.hermann@pionix.de> --------- Signed-off-by: Andreas Heinrich <andreas.heinrich@rwth-aachen.de> Signed-off-by: Kai-Uwe Hermann <kai-uwe.hermann@pionix.de> Co-authored-by: Kai-Uwe Hermann <kai-uwe.hermann@pionix.de>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
* doc(tutorial): Added Plug&Charge tutorial to docs --------- Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
* doc(how-to): Add Configure Plug&Charge in EVerest --------- Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
* doc(tutorial): Add OCPP1.6 tutorial --------- Signed-off-by: Piet Gömpel <pietgoempel@gmail.com> Signed-off-by: Piet Gömpel <37657534+Pietfried@users.noreply.github.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com> Signed-off-by: Piet Gömpel <37657534+Pietfried@users.noreply.github.com>
* doc(how-to): Add debug ISO15118 documentation --------- Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com> Co-authored-by: Piet Gömpel <pietgoempel@gmail.com>
* doc(tutorial): Add develop new modules --------- Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
* doc(linux/yocto): Added several documentation parts for Linux/Yocto integration --------- Signed-off-by: Piet Gömpel <pietgoempel@gmail.com> Signed-off-by: Piet Gömpel <37657534+Pietfried@users.noreply.github.com>
…ging Regulations to documentation (#1494) Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
* doc(how-to): Add Renesas MPU docs --------- Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
… as part of EVerest doc (#1564) * docs(api): Move asyncapi spec and provide HTMLs as part of EVerest doc --------- Signed-off-by: Christoph Burandt <christoph.burandt@pionix.de>
…nt) (#1581) Signed-off-by: Christoph Burandt <christoph.burandt@pionix.de>
* doc(how-to): Add BringUp documentation for basic, ac, dc and powermeter bringup --------- Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
* doc(explanation): Add adapt EVerest documentation --------- Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
* doc(getting-started): Added Getting Started guides for SW and HW --------- Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Christoph Burandt <christoph.burandt@pionix.de>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
unresolved refs with "TODO") Signed-off-by: Christoph Burandt <christoph.burandt@pionix.de>
Signed-off-by: Christoph Burandt <christoph.burandt@pionix.de>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
…ly to APIs Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Christoph Burandt <christoph.burandt@pionix.de>
Signed-off-by: Christoph Burandt <christoph.burandt@pionix.de>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Signed-off-by: Piet Gömpel <pietgoempel@gmail.com>
Pietfried
force-pushed
the
feature/docs-migration
branch
from
55cca87 to
eacde18
Compare
Signed-off-by: Christoph Burandt <christoph.burandt@pionix.de>
Signed-off-by: Christoph Burandt <christoph.burandt@pionix.de>
Signed-off-by: Christoph Burandt <christoph.burandt@pionix.de>
Signed-off-by: Christoph Burandt <christoph.burandt@pionix.de>
Signed-off-by: Christoph Burandt <christoph.burandt@pionix.de>
Signed-off-by: Christoph Burandt <christoph.burandt@pionix.de>
Signed-off-by: Christoph Burandt <christoph.burandt@pionix.de>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Describe your changes
This PR introduces documentation sources and build tooling for the new EVerest documentation, which applies the diataxis format. Every part of the documentation is sorted into one of these categories:
We started with the documentation skeleton in the branch-protected
featrue/docs-migrationbranch a few weeks ago and reviewed and merged single documentation bits seperately into this branch, which now contains the composition of the changes.Many parts of the existing documentation of https://everest.github.io/nightly/ has been reused and/or revised. A lot of additional documentation has been added:
and much more.
A preview of the documentation is available on https://everest.github.io/everest-core .
Issue ticket number and link
Checklist before requesting a review