Add documentation section to README.md (#461) #476
Merged
Conversation
This file contains hidden or 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
Contributor
Author
|
The documentation section was accidentally added to the release/2.0 branch first instead of develop. Add it to develop as well. |
trurlurl
reviewed
Aug 26, 2025
|
|
||
| ## GitHub Repository | ||
| Download the XSD schema files and examples in the git repository found at https://github.com/VDVde/OJP and take a look at the [documentation tables](https://vdvde.github.io/OJP/index.html). | ||
| Download the XSD schema files and examples in the git repository found at [https://github.com/VDVde/OJP](https://github.com/VDVde/OJP). |
Contributor
There was a problem hiding this comment.
Suggested change
| Download the XSD schema files and examples in the git repository found at [https://github.com/VDVde/OJP](https://github.com/VDVde/OJP). | |
| Download the XSD schema files and examples from the git repository found at [https://github.com/VDVde/OJP](https://github.com/VDVde/OJP). |
Contributor
Author
Contributor
There was a problem hiding this comment.
I imagined that we could introduce it just for the future and leave it for 2.0, thus having this small difference. But the problem is really minor, I have absolutely no problem if you prefer merging it just like that.
| ## GitHub Repository | ||
| Download the XSD schema files and examples in the git repository found at https://github.com/VDVde/OJP and take a look at the [documentation tables](https://vdvde.github.io/OJP/index.html). | ||
| Download the XSD schema files and examples in the git repository found at [https://github.com/VDVde/OJP](https://github.com/VDVde/OJP). | ||
| The [documentation tables](https://vdvde.github.io/OJP/index.html) are generated for each relevant branch automatically (when the branch itself is valid). |
Contributor
There was a problem hiding this comment.
Suggested change
| The [documentation tables](https://vdvde.github.io/OJP/index.html) are generated for each relevant branch automatically (when the branch itself is valid). | |
| The [documentation tables](https://vdvde.github.io/OJP/index.html) are generated for each relevant branch automatically (provided the branch itself is valid). |
ue71603
approved these changes
Aug 26, 2025
trurlurl
approved these changes
Aug 27, 2025
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.
No description provided.