-
Notifications
You must be signed in to change notification settings - Fork 4
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
add empty md files to mirror gdoc guide #16
Conversation
for more information, see https://pre-commit.ci
Reviewer's Guide by SourceryThis 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
Tips
|
There was a problem hiding this 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
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 |
There was a problem hiding this comment.
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.
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: