Skip to content

Docs/add errors to reference section #1686

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Draft
cburandt wants to merge 53 commits into
base: main
Choose a base branch
from
Draft

Docs/add errors to reference section #1686

cburandt wants to merge 53 commits into from

Conversation

@cburandt
Copy link
Contributor

@cburandt cburandt commented Dec 23, 2025

Describe your changes

Errors were missing from the reference section.

WIP: Still incomplete, since the errors are only listed on the interface pages

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
@krealyt @Pietfried
This adds a documentation skeleton to everest-core in its docs/ direc…
31844bf 
…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 <[email protected]>
Signed-off-by: Andreas Heinrich <[email protected]>
Signed-off-by: Piet Gömpel <[email protected]>
Co-authored-by: Piet Gömpel <[email protected]>
@andistorm @Pietfried
(docs) add community channels (#1448)
2a0f1c1 
* doc(explanation): Add community channels to docs

Signed-off-by: Piet Gömpel <[email protected]>
---------

Signed-off-by: Piet Gömpel <[email protected]>
Co-authored-by: Piet Gömpel <[email protected]>
@Pietfried
doc(pnc): Add Explaination of Plug&Charge in EVerest (#1429)
e9fc01b 
Signed-off-by: Piet Gömpel <[email protected]>
@andistorm @hikinggrass @Pietfried
Refactor _find_sphinx_build macro to allow system installation of sph…
ea15d69 
…inx (#1477)

* Refactor _find_sphinx_build macro to allow system installation of sphinx

Signed-off-by: Andreas Heinrich <[email protected]>

* 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 <[email protected]>

---------

Signed-off-by: Andreas Heinrich <[email protected]>
Signed-off-by: Kai-Uwe Hermann <[email protected]>
Co-authored-by: Kai-Uwe Hermann <[email protected]>
@Pietfried
doc(tutorial): Add bazel documentation (#1456)
283239e 
Signed-off-by: Piet Gömpel <[email protected]>
@Pietfried
Add Plug&Charge tutorial documentation (#1439)
780c631 
* doc(tutorial): Added Plug&Charge tutorial to docs
---------

Signed-off-by: Piet Gömpel <[email protected]>
@Pietfried
Add Configure Plug&Charge in EVerest documentation (#1428)
e53f5f8 
* doc(how-to): Add Configure Plug&Charge in EVerest
---------

Signed-off-by: Piet Gömpel <[email protected]>
@Pietfried
doc(explanation): Add devtool documentation (#1445)
b153642 
Signed-off-by: Piet Gömpel <[email protected]>
@Pietfried
Add OCPP1.6 documentation (#1434)
1e96896 
* doc(tutorial): Add OCPP1.6 tutorial

---------

Signed-off-by: Piet Gömpel <[email protected]>
Signed-off-by: Piet Gömpel <[email protected]>
@Pietfried
doc(tutorial): Added OCPP2.x tutorial to docs (#1435)
2f5bf04 
Signed-off-by: Piet Gömpel <[email protected]>
Signed-off-by: Piet Gömpel <[email protected]>
@Pietfried
Add ISO15118 debugging documentation (#1495)
99c6630 
* doc(how-to): Add debug ISO15118 documentation
---------

Signed-off-by: Piet Gömpel <[email protected]>
@andistorm @Pietfried
doc(explanation): Add hardware architecture documentation (#1449)
4b0072d 
Signed-off-by: Piet Gömpel <[email protected]>
Co-authored-by: Piet Gömpel <[email protected]>
@Pietfried
Add develop new modules to documentation (#1458)
2276d0a 
* doc(tutorial): Add develop new modules
---------

Signed-off-by: Piet Gömpel <[email protected]>
@Pietfried
Add documentation for Linux/Yocto/Cross compilation (#1459)
9a94bce 
* doc(linux/yocto): Added several documentation parts for Linux/Yocto integration
---------

Signed-off-by: Piet Gömpel <[email protected]>
Signed-off-by: Piet Gömpel <[email protected]>
@Pietfried
docs(explanation): Adds how-to guides for Eichrecht and UK Smart Char…
365e4cf 
…ging Regulations to documentation (#1494)

Signed-off-by: Piet Gömpel <[email protected]>
@Pietfried
doc(explanation): Add High-Level EVerest overview to docs (#1453)
d55e839 
Signed-off-by: Piet Gömpel <[email protected]>
@Pietfried
Add renesas mpu docs (#1457)
da173ca 
* doc(how-to): Add Renesas MPU docs

---------

Signed-off-by: Piet Gömpel <[email protected]>
@Pietfried
doc(how-to): Add security best practices to documentation (#1573)
a9aecdf 
Signed-off-by: Piet Gömpel <[email protected]>
@cburandt @Pietfried
docs(api): Move EVerest API asyncapi spec and build and provide HTMLs…
d5c8afe 
… as part of EVerest doc (#1564)

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

Signed-off-by: Christoph Burandt <[email protected]>
@cburandt @Pietfried
docs: fix various bugs (broken links, broken formating, missing conte…
2c89caa 
…nt) (#1581)

Signed-off-by: Christoph Burandt <[email protected]>
@Pietfried
Add basic BringUp documentation (#1576)
a263914 
* doc(how-to): Add BringUp documentation for basic, ac, dc and powermeter bringup
---------

Signed-off-by: Piet Gömpel <[email protected]>
@Pietfried
Add Adapt EVerest documentation (#1577)
631d745 
* doc(explanation): Add adapt EVerest documentation
---------

Signed-off-by: Piet Gömpel <[email protected]>
@Pietfried
Add Getting Started documentation (#1574)
e2ecd25 
* doc(getting-started): Added Getting Started guides for SW and HW
---------

Signed-off-by: Piet Gömpel <[email protected]>
@Pietfried
Formatting fixes in getting started docs
067fb80 
Signed-off-by: Piet Gömpel <[email protected]>
@Pietfried
Fix references in asnycapi docs
9d9e96f 
Signed-off-by: Piet Gömpel <[email protected]>
@Pietfried
Move from doc.rst -> docs/index.rst in BUOcppConsumer and IMDSimulator
5300fc3 
Signed-off-by: Piet Gömpel <[email protected]>
@cburandt @Pietfried
Fix broken links
48a2eac 
Signed-off-by: Christoph Burandt <[email protected]>
@Pietfried
Add TSC section in community channels
d7d96b7 
Signed-off-by: Piet Gömpel <[email protected]>
@Pietfried
Updated tsc resources
fd3a5e5 
Signed-off-by: Piet Gömpel <[email protected]>
@Pietfried
Updated repo to dev-hardware-yocto
feda2af 
Signed-off-by: Piet Gömpel <[email protected]>
Pietfried and others added 23 commits December 22, 2025 10:47
@Pietfried
Update headline
ce286ad 
Signed-off-by: Piet Gömpel <[email protected]>
@Pietfried
Update images
856a885 
Signed-off-by: Piet Gömpel <[email protected]>
@Pietfried
Fix TODOs and add EVerest APIs to Getting Started section
5b29709 
Signed-off-by: Piet Gömpel <[email protected]>
@cburandt @Pietfried
Minor fixes (links + avoid warnings, remove references to BC, mark
77259e9 
unresolved refs with "TODO")

Signed-off-by: Christoph Burandt <[email protected]>
@cburandt @Pietfried
Add OTA RAUC partitioning + drivers (from BC appendix)
7d691b4 
Signed-off-by: Christoph Burandt <[email protected]>
@Pietfried
added index.rst for all BU modules
44ddc01 
Signed-off-by: Piet Gömpel <[email protected]>
@Pietfried
Removed adapt everest from toctree and link in getting started direct…
66baa7a 
…ly to APIs

Signed-off-by: Piet Gömpel <[email protected]>
@Pietfried
Add qa to toc
f4af9b7 
Signed-off-by: Piet Gömpel <[email protected]>
@Pietfried
Remove checkboxes
33aadb4 
Signed-off-by: Piet Gömpel <[email protected]>
@Pietfried
Fix markdown link
23275d1 
Signed-off-by: Piet Gömpel <[email protected]>
@cburandt @Pietfried
Suppress sphinx warnings
679f038 
Signed-off-by: Christoph Burandt <[email protected]>
@cburandt @Pietfried
Fix visual appearance and some formatting violations
5c7b69c 
Signed-off-by: Christoph Burandt <[email protected]>
@Pietfried
Move Huawei driver docs to docs/index.rst
8be93ba 
Signed-off-by: Piet Gömpel <[email protected]>
@Pietfried
Remove add_subdirectory(doc)
02038d8 
Signed-off-by: Piet Gömpel <[email protected]>
@Pietfried
Move EnergyManager module docs to seperate chapter in explanation/
eacde18 
Signed-off-by: Piet Gömpel <[email protected]>
@cburandt
Rework index page and add some guidance for starters
6f9dcce 
Signed-off-by: Christoph Burandt <[email protected]>
@cburandt
Allow to build docs without async-api-depending API docs
b670495 
Signed-off-by: Christoph Burandt <[email protected]>
@cburandt
Move 'community' to the sidebar
76aae37 
Signed-off-by: Christoph Burandt <[email protected]>
@cburandt
Fix broken links/references
406ed12 
Signed-off-by: Christoph Burandt <[email protected]>
@cburandt
Add 'Documenting EVerest' material
6b100e5 
Signed-off-by: Christoph Burandt <[email protected]>
@cburandt
Add Q&A content
dc87ecc 
Signed-off-by: Christoph Burandt <[email protected]>
@cburandt
Add error framework content
f572402 
Signed-off-by: Christoph Burandt <[email protected]>
@cburandt
WIP: Add errors to reference section
bb43a85 
Signed-off-by: Christoph Burandt <[email protected]>
@cburandt cburandt added the documentation Improvements or additions to documentation label Dec 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@SebaLukas SebaLukas Awaiting requested review from SebaLukas SebaLukas will be requested when the pull request is marked ready for review SebaLukas is a code owner

@Pietfried Pietfried Awaiting requested review from Pietfried Pietfried will be requested when the pull request is marked ready for review Pietfried is a code owner

@hikinggrass hikinggrass Awaiting requested review from hikinggrass hikinggrass will be requested when the pull request is marked ready for review hikinggrass is a code owner

@corneliusclaussen corneliusclaussen Awaiting requested review from corneliusclaussen corneliusclaussen will be requested when the pull request is marked ready for review corneliusclaussen is a code owner

@dorezyuk dorezyuk Awaiting requested review from dorezyuk dorezyuk will be requested when the pull request is marked ready for review dorezyuk is a code owner

@rckstrh rckstrh Awaiting requested review from rckstrh rckstrh will be requested when the pull request is marked ready for review rckstrh is a code owner

@mlitre mlitre Awaiting requested review from mlitre mlitre will be requested when the pull request is marked ready for review mlitre is a code owner

@florinmihut florinmihut Awaiting requested review from florinmihut florinmihut will be requested when the pull request is marked ready for review florinmihut is a code owner

@djchhp djchhp Awaiting requested review from djchhp djchhp will be requested when the pull request is marked ready for review djchhp is a code owner

@james-ctc james-ctc Awaiting requested review from james-ctc james-ctc will be requested when the pull request is marked ready for review james-ctc is a code owner

@a-w50 a-w50 Awaiting requested review from a-w50 a-w50 will be requested when the pull request is marked ready for review a-w50 is a code owner

@andistorm andistorm Awaiting requested review from andistorm andistorm will be requested when the pull request is marked ready for review andistorm is a code owner

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@cburandt @krealyt @andistorm @Pietfried