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.

Sign up for GitHub

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

Jump to bottom

[FIX] misc minor fixes to the documentation #482

Merged
merged 11 commits into from
May 12, 2024
Merged

[FIX] misc minor fixes to the documentation #482

merged 11 commits into from
May 12, 2024

Conversation

Remi-Gau
Copy link
Collaborator

@Remi-Gau Remi-Gau commented May 10, 2024 •
edited
Loading

relates to #478

  • about_this_doc should become a CONTRIBUTING.md
  • remove numbers prefix in filenames
  • ensure that all code blocks have syntax highlighting
  • ensure proper formatting of markdown by applying remark linting rules

@Remi-Gau
Copy link
Collaborator Author

That's a lot of line changes but mostly because of applying the remark markdown linting.

@Remi-Gau
Copy link
Collaborator Author

will implement the other changes from #478 in a follow-up PR to help with review

This was referenced May 10, 2024
Merged
Closed
yibeichan
yibeichan reviewed May 11, 2024
View reviewed changes
Copy link
Contributor

@yibeichan yibeichan left a comment

Choose a reason for hiding this comment

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

looks good! i left some comments there; once we resolve them, we can merge this one

docs/introduction.md Show resolved Hide resolved
docs/introduction.md Show resolved Hide resolved
docs/introduction.md Show resolved Hide resolved
docs/introduction.md Show resolved Hide resolved
docs/introduction.md Show resolved Hide resolved
docs/schema.md Show resolved Hide resolved
docs/user_guide/create-new-assess.md Outdated Show resolved Hide resolved
docs/user_guide/create-new-assess.md Outdated Show resolved Hide resolved
docs/user_guide/create-new-protocol.md Outdated Show resolved Hide resolved
mkdocs.yml Outdated Show resolved Hide resolved
yibeichan
yibeichan reviewed May 12, 2024
View reviewed changes
Copy link
Contributor

@yibeichan yibeichan left a comment

Choose a reason for hiding this comment

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

good, good; there are only two filenames we may want to change from _ to - if remarks doesn't complain. then, everything should be consistent

mkdocs.yml Outdated Show resolved Hide resolved
mkdocs.yml Outdated Show resolved Hide resolved
@Remi-Gau
Copy link
Collaborator Author

@yibeichan
will let you merge if you think this is good to go

@yibeichan yibeichan merged commit 3a8aa0c into ReproNim:master May 12, 2024
4 checks passed
@Remi-Gau Remi-Gau deleted the fix/doc branch June 17, 2024 17:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@yibeichan yibeichan yibeichan left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Remi-Gau @yibeichan