Skip to content

add empty md files to mirror gdoc guide #16

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

Merged
merged 2 commits into from
Sep 16, 2024

Conversation

marcobarilari
Copy link
Contributor

@marcobarilari marcobarilari commented Sep 16, 2024

Summary by Sourcery

Update the documentation navigation structure in mkdocs.yml to include new sections and empty markdown files that mirror a Google Doc guide, enhancing the organization and future content planning.

Documentation:

  • Add new empty markdown files to mirror the structure of a Google Doc guide, organizing them under sections such as 'Welcome', 'Life in lab', and 'Activities'.

@marcobarilari marcobarilari marked this pull request as ready for review September 16, 2024 14:37
Copy link
Contributor

sourcery-ai bot commented Sep 16, 2024

Reviewer's Guide by Sourcery

This pull request updates the mkdocs.yml file to restructure the navigation of the documentation. It adds new sections and pages, reorganizing the content to provide a more comprehensive and organized guide.

File-Level Changes

Change Details Files
Restructure navigation in mkdocs.yml
  • Change 'Welcome and FAQ' to 'Home'
  • Add 'Welcome section' with subpages for registration and living in Belgium
  • Add 'Life in lab' section with multiple subpages covering various aspects of lab life
  • Add 'Activities' section with subpages for learning French and fun activities
  • Retain 'Contributing' page
mkdocs.yml

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • Continue your discussion with Sourcery by replying directly to review comments.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @marcobarilari - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding content to the newly created pages soon to avoid having a structure full of empty pages.
  • There's a typo in 'Learnign French' - it should be 'Learning French'.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

- Conference posters: conference_posters.md
- Papers: papers.md
- Activities:
- Learnign French: learning_french.md
Copy link
Contributor

Choose a reason for hiding this comment

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

issue (typo): Fix typo in 'Learning French' entry

The word 'Learning' is misspelled as 'Learnign' in the Activities section. This should be corrected to ensure proper linking and navigation in the documentation.

@fcerpe fcerpe merged commit 53de8e3 into cpp-lln-lab:main Sep 16, 2024
1 check passed
@marcobarilari marcobarilari deleted the marco_add-empty-md-files branch September 19, 2024 07:24
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