Skip to content

Quick start - #1787

Merged
SouthEndMusic merged 13 commits into
mainfrom
quick-start
Sep 3, 2024
Merged

Quick start#1787
SouthEndMusic merged 13 commits into
mainfrom
quick-start

Conversation

@Jingru923

Copy link
Copy Markdown
Contributor

Fixes #1158

The quick start guide is now also in our documentation.

When I was working on this, I thought about what is the best way to make sure the offline and online one are synchronized, so that when we modify the old module or add new module to the docx, it can be updated in the documentation.

I tried conversion between docx and qmd and it doesn't work very well.

For now I suggest we should keep to modifying the qmd instead of modifying the docx.

@Jingru923 Jingru923 linked an issue Sep 2, 2024 that may be closed by this pull request
3 tasks

@SouthEndMusic SouthEndMusic left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I added a lot of nitpicks, most of it is to make it look a bit nicer and more consistent with the rest of the docs. I suggest @Fati-Mon also has a look before merging

Comment thread docs/guide/quickstart.qmd
Comment thread docs/guide/quickstart.qmd Outdated
Comment thread docs/guide/quickstart.qmd Outdated
Comment thread docs/guide/quickstart.qmd
Comment thread docs/guide/quickstart.qmd Outdated
Comment thread docs/guide/quickstart.qmd Outdated
Comment thread docs/guide/quickstart.qmd Outdated
Comment thread docs/guide/quickstart.qmd
Comment thread docs/guide/quickstart.qmd Outdated
Comment thread docs/guide/quickstart.qmd

@SouthEndMusic SouthEndMusic left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Nice that we have this now

@SouthEndMusic
SouthEndMusic merged commit 1943a19 into main Sep 3, 2024
@SouthEndMusic
SouthEndMusic deleted the quick-start branch September 3, 2024 11:23
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.

Add a quick start guide

2 participants