Skip to content

Documentation: Contribution Tutorial#1909

Open
krealyt wants to merge 55 commits intoEVerest:mainfrom
krealyt:feature/docs-migration
Open

Documentation: Contribution Tutorial#1909
krealyt wants to merge 55 commits intoEVerest:mainfrom
krealyt:feature/docs-migration

Conversation

@krealyt
Copy link
Contributor

@krealyt krealyt commented Mar 3, 2026

Describe your changes

I added a tutorial page to reflect the EVerest way of contributing.

Issue ticket number and link

Checklist before requesting a review

  • I have performed a self-review of my code
  • I have made corresponding changes to the documentation
  • I read the contribution documentation and made sure that my changes meet its requirements

krealyt and others added 30 commits December 22, 2025 10:46
…tory. (EVerest#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 (EVerest#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 (EVerest#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 (EVerest#1564)

* docs(api): Move asyncapi spec and provide HTMLs as part of EVerest doc
---------

Signed-off-by: Christoph Burandt <christoph.burandt@pionix.de>
…nt) (EVerest#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>
Pietfried and others added 16 commits December 22, 2025 10:47
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>
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>
Signed-off-by: Krealyt <manuel.ziegler@pionix.de>
Signed-off-by: Krealyt <manuel.ziegler@pionix.de>
Signed-off-by: Krealyt <manuel.ziegler@pionix.de>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants