Add README section for host modules #518
Closed
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
andreaTP
requested changes
Sep 9, 2024
andreaTP
reviewed
Sep 9, 2024
andreaTP
reviewed
Sep 9, 2024
| <path> | ||
| <groupId>com.dylibso.chicory</groupId> | ||
| <artifactId>function-processor</artifactId> | ||
| <version>0.0.12</version> |
There was a problem hiding this comment.
What about using a placeholder for the version number?
Alternatively, it needs to be updated by the release process by this script:
https://github.com/dylibso/chicory/blob/main/scripts/update-readme-version.sh
There was a problem hiding this comment.
Looks like the script will already update it, as it's the same format as a normal dependency?
Edit: seems we need to make the leading white space in the regex more flexible.
|
This needs to target the new Maybe a good first issue for @kanatohodets that demonstrated interest in working on the documentation side? |
kanatohodets
added a commit
to kanatohodets/chicory
that referenced
this pull request
Oct 29, 2024
This commit moves the README additions from dylibso#518 into the docs site. Per Andrea's feedback on that PR, I removed mentions of `@Buffer` or `@CString`.
Merged
andreaTP
pushed a commit
that referenced
this pull request
Oct 30, 2024
Following up on #518, this moves @electrum's Host Module docs into the docs site. I omitted mentions of `@Buffer` and `@CString` since Andrea's feedback on #518 mentioned that those are still in flux. Also tossed off a script to replace `scripts/update-readme-version.sh`. Same thing but a Perl script which crawls the `docs/docs` dir for any markdown files and swaps `DOCS_PLACEHOLDER_VERSION` for the given value. I did take a quick look into Docusaurus plugins to handle this, but I think I'd need a custom remark plugin and I didn't have capacity to go down that road.
|
Superseded by #628 |
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.