Fixing text some details in dev documentation #510
Conversation
… to resize images
|
Is this working? I still see the |
There was a problem hiding this comment.
Please fix ASAP.
Also the problem with the images <p align="center"><img width=. If not sure how it is done, please ask in the #documentation channel in Julia's Slack, I would try to avoid using raw HTML blocks, as they do not work with VitepressDocumenter.jl.
| ```shell | ||
| (KomaMRI) pkg> dev ./KomaMRIBase ./KomaMRICore ./KomaMRIFiles ./KomaMRIPlots | ||
| pkg> activate KomaMRICore | ||
| pkg> dev ./KomaMRIBase | ||
| pkg> instantiate | ||
|
|
||
| pkg> activate KomaMRIFiles | ||
| pkg> dev ./KomaMRIBase | ||
| pkg> instantiate | ||
|
|
||
| pkg> activate KomaMRIPlots | ||
| pkg> dev ./KomaMRIBase | ||
| pkg> instantiate | ||
|
|
||
| pkg> activate . | ||
| pkg> dev ./KomaMRICore ./KomaMRIFiles ./KomaMRIPlots | ||
| pkg> instantiate | ||
| ``` | ||
| Finally, use the `instantiate` command to install all the required packages (specified in the `Project.toml`): | ||
| In case you want to contribute specifically in documentation, you will need to use the `docs` enviroment with the following script: | ||
|
|
||
| ```shell | ||
| (KomaMRI) pkg> instantiate | ||
| pkg> activate docs | ||
| pkg> dev ./KomaMRI | ||
| pkg> instantiate | ||
|
|
||
| ``` |
There was a problem hiding this comment.
Was the instantiate necessary? (look into Koma's CI setup) There is an additional new line after the last instantiate. The command to setup the monorepo is too long, put inside a !!! details callout, so it is collapsable.
There was a problem hiding this comment.
It wasn't necessary. Corrected in commit a26a42c
|
This branch is up to date in commit 77ea23d |
cncastillo
changed the title
cncastillo
changed the title
| As KomaMRI.jl contains multiple packages in one GitHub repository, you need to specify that you want to use your local copies (instead of the ones available on the Julia registries) and using the `instantiate` command to install all the required packages (specified in `project.toml`) with the following script: | ||
|
|
||
| ```julia-repl | ||
| using Pkg | ||
| Pkg.activate("KomaMRICore") | ||
| Pkg.develop(path = "./KomaMRIBase") | ||
|
|
||
| Pkg.activate("KomaMRIFiles") | ||
| Pkg.develop(path = "./KomaMRIBase") | ||
|
|
||
| Pkg.activate("KomaMRIPlots") | ||
| Pkg.develop(path = "./KomaMRIBase") | ||
|
|
||
| Pkg.activate(".") | ||
| Pkg.develop(path = "./KomaMRICore") | ||
| Pkg.develop(path = "./KomaMRIFiles") | ||
| Pkg.develop(path = "./KomaMRIPlots") | ||
| ``` | ||
| Finally, use the `instantiate` command to install all the required packages (specified in the `Project.toml`): | ||
| ```shell | ||
| (KomaMRI) pkg> instantiate | ||
| In case you want to contribute specifically in documentation, you will need to use the `docs` enviroment with the following script: | ||
|
|
||
| ```julia-repl | ||
| Pkg.activate("docs") | ||
| Pkg.develop(path = ".") |
There was a problem hiding this comment.
-
Do not use
julia-replfor syntax highlighting, usejulia. -
Project.toml instead of project.toml.
-
Are you sure at least one
instantiateis not necessary? -
You did not put the foldable part, as asked in a previous review comment Fixing text some details in dev documentation #510 (comment). You could also do this to make it shorter:
using Pkg
# Koma sub-packages dev setup
koma_subpkgs = ["KomaMRICore", "KomaMRIFiles", "KomaMRIPlots"]
for pkg in koma_subpkgs
Pkg.activate(pkg)
Pkg.develop(path = "./KomaMRIBase")
end
# Main package (KomaMRI) dev setup
Pkg.activate(".")
for pkg in koma_subpkgs
Pkg.develop(path = "./$pkg")
end
# Pkg.instantiate() ???
Fixed the appearance of text in "5-contribute-to-koma.md"