Create integrated documentation #2
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
enikao
reviewed
May 19, 2025
| { | ||
| Key = "key-lang", | ||
| Version = "0", | ||
| Name = "Complaints Language", |
Contributor
There was a problem hiding this comment.
This is not a valid name -- we defined all IKeyed names must be valid programming identifiers
dslmeinte
approved these changes
May 19, 2025
| { | ||
| public static void Run() | ||
| { | ||
|
|
Contributor
Author
There was a problem hiding this comment.
Right, I will remove it
There was a problem hiding this comment.
Isn't this a duplicate of the file directly under examples-ts/?
Contributor
Author
There was a problem hiding this comment.
Right, removing a copy
|
|
||
| ```shell | ||
| # Run the tests | ||
| npm run test |
There was a problem hiding this comment.
"npm test" does the same thing, and is slightly more ideomatic.
Contributor
Author
There was a problem hiding this comment.
noted, thank you
Contributor
Author
|
Merging, after discussion during the meeting and because approved by Meinte |
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.
This is a draft PR, as requested by @enikao .
In this PR we:
I then plan to add a GitHub action to manage the publication, similarly to what we do here.
The quality of the documentation is not great, but I hope it can serve as a starting point and that we can then incrementally improving it over time.
To check the documentation, run
npm run startfrom the website directory.Todo