Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed text appearance in documentation #510

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

Stockless
Copy link
Contributor

Fixed the appearance of text in "5-contribute-to-koma.md"

@cncastillo
Copy link
Member

cncastillo commented Nov 22, 2024

Is this working? I still see the <p align="center"><img width="100%" src="../assets/create-fork-step1.png" /></p> that you said didn't work to center the images. Also, the Pkg operations didn't work on Windows. Use Pkg directly.

Copy link
Member

@cncastillo cncastillo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment on lines 65 to 89
```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

```
Copy link
Member

@cncastillo cncastillo Nov 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was the instantiate necessary? (look into Koma's CI setup) There is an additional new line after the las instantiate. The command to setup the monorepo is too long, put inside a !!! details callout, so it is collapsable.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants