Updated readme and autogenerated doc #53
Open
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
This initial documentation section has been unchanged since v0.1.0 and has been outdated in all later versions. Version information is now present as library annotation parameters that OMEdit shows in the Documentation Browser for all documentation pages of this library, and therefore not needed as text in the documentation.
The DocumentationClass parameter was inserted into Documentation by a mistake. Moved to the outer annotation scope to have any effect.
The outdated year was commented by @benjamsy in a review. Co-authored-by: benjamsy <[email protected]>
Specifying this as true at the UsersGuide top level will make "info" the preferred view for all subpages under UsersGuide.
Improve documentation. No functional changes.
The main purpose is to make it easier for library users to find the DOI they should use when citing this library.
- Updated readme - Updated autogenerated docs folder
benjamsy
requested review from
daniPclos-Sintef
and removed request for
jsimonclark
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.
Updated readme to be clear that the library is not currently being maintained and that work on Virtual-FCS will resume in 2026.
Updated autogenerated html documentation to be linked to doc build.