Revise the documentation #63
Open
Conversation
This file contains 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
There are still some old parts in the documentation but also new parts. We need to bring everything in line and decide what to keep and what to remove.
Now both variants are integrated but we have to decide which one to take. Using separate file as we did before or using one changelog file like CHANGELOG.rst
We have to clean this site.
We have to add the examples again but we should discuss how.
|
@oemof/feedinlib : I would appreciate some help, ideas and feedback. |
|
@uvchik what is the difference between changelog and what's new? I don't have a strong opinion on it but if there is no advantage of changelog over what's new I would just keep it as it is. I will add some information on the weather data, otherwise I think the documentation is fine. I also think the basic usage part of the documentation is fine. What would you add or change? |
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.
There are still some old parts in the documentation but also new parts. We need to bring everything in line and decide what to keep and what to remove.
See this branch on readthedocs