Restructure and improve the docs #679
Conversation
Deploying chicory with
|
| Latest commit: |
0f8c167
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://5d761d76.chicory.pages.dev |
| Branch Preview URL: | https://docs-revamp.chicory.pages.dev |
|
cc. @kanatohodets please feel free to review the new structure. On top of this, either you look for gaps yourself(there are for sure) or, I would go for the examples: #667 For TinyGo I think this PR is the best "getting started". |
docs/docs/experimental/3-aot.md
Outdated
|
|
||
| ## Pre-compiled AOT | ||
|
|
||
| You can use the AOT compiler at build-time, by leveraging a [Maven plug-in][aot-maven-plugin] to overcome the usage of reflection and external dependencies of the "Runtime AOT". |
There was a problem hiding this comment.
The aot-maven-plugin link doesn't work (no suggestion since I'm not sure what you intended)
There was a problem hiding this comment.
Let's name this file host-module-annotations or just host-modules. The abbreviation looks strange.
docs/docs/experimental/3-aot.md
Outdated
|
|
||
| #### IDE shortcomings | ||
|
|
||
| In some IDEs the sources generated under the standard folder `target/generated-sources` are not automatically recognized. |
There was a problem hiding this comment.
Which IDEs? This works correctly in IntelliJ.
There are sometimes issues with needing to force refresh or ignore/uniginore the modules when doing development of Chicory itself after switching branches/etc., but this shouldn't be a problem for normal users of Chicory.
Even when developing Chicory, the generates-sources/chicory-aot directory gets registered automatically for me in the wabt module, once everything "stabilizes".
There was a problem hiding this comment.
It's a known issue in VSCode and Eclipse, I added the note as I've been requested a fix a few times here and in various other projects.
It's unnecessary, but doesn't hurt either in IntelliJ.
Co-authored-by: David Phillips <[email protected]>
Co-authored-by: David Phillips <[email protected]>
Co-authored-by: David Phillips <[email protected]>
Co-authored-by: David Phillips <[email protected]>
Co-authored-by: David Phillips <[email protected]>
Co-authored-by: David Phillips <[email protected]>
Co-authored-by: David Phillips <[email protected]>
Co-authored-by: David Phillips <[email protected]>
Co-authored-by: David Phillips <[email protected]>
Co-authored-by: David Phillips <[email protected]>
Co-authored-by: David Phillips <[email protected]>
Co-authored-by: David Phillips <[email protected]>
Co-authored-by: David Phillips <[email protected]>
Co-authored-by: David Phillips <[email protected]>
Co-authored-by: David Phillips <[email protected]>
Co-authored-by: David Phillips <[email protected]>
Co-authored-by: David Phillips <[email protected]>
Co-authored-by: David Phillips <[email protected]>
Co-authored-by: David Phillips <[email protected]>
Supersede #675 opening the PR in the main repo to (hopefully) get the Cloudflare preview.