Skip to content
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.

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

Documentation: Refactoring of the README #842

Open
4 tasks
Pietfried opened this issue Oct 23, 2024 · 1 comment
Open
4 tasks

Documentation: Refactoring of the README #842

Pietfried opened this issue Oct 23, 2024 · 1 comment

Comments

@Pietfried
Copy link
Contributor

Pietfried commented Oct 23, 2024

OCPP Version

OCPP1.6, OCPP2.0.1

Describe the problem

The current README is very bloated and partly contains information that we plan to move to other parts of libocpp.

Describe your solution

We decided to not merge the structure proposed in We decided to not merge the structure proposed in #836 but to accept certain parts of it as part of a seperate PR that refactors the README.

The goal of this issue is to reduce the README and to seperate better between user and developer documentation.

These are the notes for how to modify the README that were discussed in the cloud WG F2F meeting

  • Include Generic introduction
  • Include Supported functionality / feature profiles
  • Include CSMS compatability
  • Include Integration in EVerest
  • Reduce section "Integrate this library" and move to developer documentation
  • Remove section "Install libocpp" -> Add Requirements for the library instead; Building and installing should be moved to developer documentation
  • Remove section "Quickstart" --> Link to EVerest SIL instead
  • Remove section "Building doxygen documentation" to developer documentation
  • Remove section "Unit testing": Move to developer documentation
  • Remove section "Building with FetchContent": Move to developer documentation
  • Remove section "Support for security profile 2 and 3 with TPM" Move to developer documentation

TODOs

  • Split up docs/ folder into docs/v16/ docs/v201/ and docs/common or docs/general
  • Review Update README and OCPP 2.0.1 documentation #836 and include parts in the refactoring PR
  • Reduce README file using the details above
  • Move removed parts of the README to the new developer documentation section

Additional context

No response

@Pietfried
Copy link
Contributor Author

#847 starts to solve parts of this issue

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

No branches or pull requests

1 participant