Improve documentation

[jainmohit2001]

Describe the documentation you'd like

• Move usage documentation from README.md to dedicated files in docs/source
• Migrate documentation to ocpp@2.0.0
• Update examples folder and migrate code to ocpp@2.0.0

[github-actions]

This issue is stale because it has been open for 30 days with no activity.

[a-alak]

I have migrated the current documentation to be compatible with ocpp@2.0.0 including the examples.
I am curious on the first task, I guess it is about simplification of the current README and moving more in depth parts to the documentation. Do you have any preferences or thoughts about how the documentation should be structured?

I have some thoughts on a complete update and expansion of the docs, and if there is no strong opinions otherwise I would go ahead and make the updates 😇

[github-actions]

This issue is stale because it has been open for 30 days with no activity.

[jainmohit2001]

Hey guys. Apologies for not getting this started soon. Been caught up with some other work. I'll be taking this up and create a plan to fix the existing documentation and improve developer onboarding.

[jainmohit2001]

We can follow the plan as mentioned below to streamline the documentation update process.
The whole update will be done in various small PRs to catch errors and complete reviews in an efficient manner.

Removing existing documentation

I think just removing the existing documentation would give us a clean slate to work with. This would ensure we don't have to manage or refactor any outdated docs.

• Cleanup main README.md and remove any source code from it. It should only contain brief description about the project and relevant GitHub related documents.
• Cleanup existing docs/source directory and remove outdated docs. Follow the latest guide from Sphinx and start from scratch.
• Remove outdated examples from examples directory

Installation, basic examples and usage ✅

Using the sphinx documentation builder, we can initiate the docs with installation and basic usage.
We should start with basic examples of CS and CSMS for both OCPP1.6 and OCPP2.0.1 versions with websockets@14 and websockets@15.

Deep dive

Here we will outline the inner workings of the package.
We can build documentation to answer the following questions:

• How does routing work?
• What is call and call_result?
• The @on and @after handler.
• How should I create my @on and @after Action handlers? What signature should I follow for the function?
• What are different dataclasses, enums and types involved?
• What does the exceptions mean and when can I expect them in the codebase?
• Various helper functions present in the package.

How Tos

This section will help developers start building real projects.

• How to deploy a CSMS and interact with the chargers through the CSMS?
• How to use HTTP calls to interact with CSMS to send data to chargers?
• How to use a queueing technology like RabbitMQ or Redis to communicate with CSMS and send data to chargers?
• How to use Django/Flask/Asyncio/FastAPI etc. as my framework?

FAQs

This section can be built incrementally based on past issues, questions and suggestion from GitHub.

[jainmohit2001]

@a-alak @mdwcrft @proelke
Let me know your thoughts here.