docs(knowledge-base): migrate 2020 cuhacking docs #132
Conversation
📝 WalkthroughWalkthroughThe changes include the addition of several new documentation files related to the CUHacking 2020 Wiki, covering topics such as the Admin Console, Application Server, Coding Guidelines, and funding implications for students. Additionally, the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant MDXComponents
participant Link
User->>MDXComponents: Request MDX content
MDXComponents->>Link: Include Link component
Link-->>MDXComponents: Return Link component
MDXComponents-->>User: Return MDX content with Link
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
❌ Deploy Preview for cuhacking-portal-dev failed. Why did it fail? →
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Caution
Inline review comments failed to post
🛑 Comments failed to post (37)
apps/docs/src/content/docs/knowledge-base/cuHacking-2020-wiki/sponsorship.mdx (1)
12-13: 💡 Codebase verification
Add missing Link component import to sponsorship.mdx.
The
Linkcomponent is used insponsorship.mdxbut is not imported. Please add the following import statement at the beginning of the file:import Link from 'path-to-link-component';Ensure the import path correctly points to the
Linkcomponent's location.🔗 Analysis chain
Verify internal links and consider adding descriptions.
The use of the
Linkcomponent for internal navigation is good. However, please ensure that:
- The
Linkcomponent is properly imported (the import statement is missing in this file).- The
SIGNATURESandSPONSORSHIP_FAQSconstants resolve to the correct paths.Additionally, consider adding brief descriptions for these links to provide context. For example:
- <Link href={SIGNATURES}>Signature Template</Link> - Use this template for official sponsorship communications - <Link href={SPONSORSHIP_FAQS}>Sponsor FAQ</Link> - Frequently asked questions by potential sponsorsTo verify the correctness of these links, you can run the following script:
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the existence of the Link component import and the correctness of the constants # Test 1: Check for Link component import echo "Checking for Link component import..." if grep -q "import.*Link.*from" apps/docs/src/content/docs/knowledge-base/cuHacking-2020-wiki/sponsorship.mdx; then echo "Link component import found." else echo "Warning: Link component import not found in sponsorship.mdx" fi # Test 2: Check the constants file echo "Checking constants.ts file..." constants_file="apps/docs/src/content/docs/knowledge-base/cuHacking-2020-wiki/constants.ts" if [ -f "$constants_file" ]; then echo "constants.ts file found. Checking for SIGNATURES and SPONSORSHIP_FAQS..." grep -n "SIGNATURES\|SPONSORSHIP_FAQS" "$constants_file" else echo "Warning: constants.ts file not found at expected location" fi # Test 3: Search for the actual files/routes that these constants might be pointing to echo "Searching for potential signature template and FAQ files..." fd -t f -e md -e mdx "(signature|faq)" apps/docs/src/content/docsLength of output: 1427
apps/docs/src/content/docs/knowledge-base/cuHacking-2020-wiki/hacker-faqs.mdx (4)
5-9: 🛠️ Refactor suggestion
Enhance the Registration section for better user experience.
While the questions are relevant, consider the following improvements:
- Add answers to the questions to make this a true FAQ.
- Use a numbered list for better readability and reference.
- Consider adding more specific questions about the registration process.
Here's an example of how you could restructure this section:
### Registration 1. **When does registration open?** Registration opens on [specific date/time]. 2. **When does registration close?** Registration closes on [specific date/time] or when we reach capacity. 3. **When will I hear back about my application?** We aim to send out all responses by [specific date]. 4. **Is there a registration fee?** [Answer about any fees or that the event is free] 5. **What information do I need to provide during registration?** [Brief list of required information]This structure provides more valuable information to potential participants and improves the overall user experience.
10-20: 🛠️ Refactor suggestion
⚠️ Potential issueImprove the "Leading up to Event" section for clarity and completeness.
The questions in this section are relevant, but consider the following improvements:
- Add answers to make this a true FAQ.
- Use a numbered list for better readability and reference.
- Group related questions together.
- Fix the grammatical issue in one question.
Here's an example of how you could restructure this section:
### Leading up to Event 1. **What are the event logistics?** - **What time should I arrive?** [Specify arrival time] - **Where is the event located?** [Provide address and any helpful landmarks] - **Is parking available?** [Information about parking options] - **Will you be providing transportation?** - We [will/will not] be sending buses from [locations]. - Travel reimbursement [is/is not] available. [If available, provide details] 2. **What should I bring?** - [List essential items, e.g., laptop, charger, sleeping bag, etc.] - **Do I need to bring my resume?** [Yes/No, and explain why] 3. **Team Formation** - **Do I need a team before the event?** [Answer about team requirements] - [Information about team formation opportunities at the event] 4. **Registration and Attendance** - **Are you accepting walk-ins?** [Yes/No, and any conditions] - **I forgot to respond to the RSVP. Can I still attend?** [Policy on RSVP and attendance] 5. **Communication** - **How can I stay updated about the event?** [Mention Slack or other communication channels]This structure groups related questions, provides a clearer organization, and fixes the grammatical issue in the original "I forgot to respond to the RSVP, can I still come?" question.
🧰 Tools
🪛 LanguageTool
[typographical] ~10-~10: It appears that a comma is missing.
Context: ...ses coming out? ### Leading up to Event * Are you accepting walk-ins? * What time sho...(COMMA_BEFORE_QUESTION_WITH_MD)
21-25: 🛠️ Refactor suggestion
Enhance the Event section with more comprehensive information.
While the current questions are relevant, consider the following improvements:
- Add answers to make this a true FAQ.
- Use a numbered list for better organization.
- Add more crucial event-day questions.
- Group related questions together.
Here's an example of how you could restructure and expand this section:
### Event Day 1. **Venue and Parking** - **Where exactly is the event taking place?** [Provide specific location details] - **Where can I find parking?** [Describe parking options] - **Is parking covered?** [Yes/No, and any relevant details] 2. **Schedule and Activities** - **Where can I find the event schedule?** [Provide link or location of schedule] - **What activities are planned during the event?** [Brief overview of activities] 3. **Communication and Support** - **How can I communicate with organizers and other participants?** - Slack link for attendees: [Provide Slack link] - **Who should I contact if I have issues during the event?** [Provide contact information] 4. **Food and Refreshments** - **Will food be provided?** [Details about meals and snacks] - **What if I have dietary restrictions?** [How to handle special dietary needs] 5. **Hardware and Resources** - **Will there be hardware available for hacking?** [Information about available hardware] - **Is there a list of API's or datasets we can use?** [Provide information or link] 6. **Submissions and Judging** - **When and how do we submit our projects?** [Submission process and deadline] - **How does the judging process work?** [Brief explanation of judging criteria and process]This expanded structure provides more comprehensive coverage of event-day information, which will be valuable for participants.
1-25: 🛠️ Refactor suggestion
Overall structure is good, but consider enhancing content and user experience.
The FAQ structure provides a solid foundation, covering key aspects of the event from registration to the event day itself. However, to maximize its usefulness for hackers, consider the following overall improvements:
- Add answers to all questions to make this a true FAQ.
- Use consistent formatting throughout, preferably with numbered lists for easy reference.
- Consider adding a table of contents at the beginning for quick navigation.
- Include links to other relevant resources or pages where appropriate.
- Add a section for post-event information (e.g., project submission, prizes, follow-up events).
Here's an example of how you could start the document with a table of contents:
--- title: Hacker FAQs description: Frequently asked questions for hackers participating in cuHacking 2020 tags: [FAQ, hackers, cuHacking2020] sidebar_position: 1 --- # Hacker FAQs ## Table of Contents 1. [Registration](#registration) 2. [Leading up to Event](#leading-up-to-event) 3. [Event Day](#event-day) 4. [Post-Event](#post-event) [Rest of the content...]By implementing these suggestions, you'll create a more comprehensive and user-friendly FAQ that will better serve the needs of hackathon participants.
🧰 Tools
🪛 LanguageTool
[typographical] ~10-~10: It appears that a comma is missing.
Context: ...ses coming out? ### Leading up to Event * Are you accepting walk-ins? * What time sho...(COMMA_BEFORE_QUESTION_WITH_MD)
apps/docs/mdx-components.tsx (1)
29-29: 💡 Codebase verification
Issues Found: Unconverted Markdown Links in MDX Files
The
Linkcomponent is correctly used in several MDX files. However, the verification revealed that there are still standard Markdown-style links present in the following files:
- apps/docs/src/content/docs/tools-overview/index.mdx
- apps/docs/src/content/docs/index.mdx
- apps/docs/src/content/docs/contribution-guidelines/writing-documentation.mdx
- ... (additional files as identified)
Please ensure that all Markdown-style links are converted to use the
Linkcomponent to maintain consistency and resolve the rendering issues outlined in the PR objectives.🔗 Analysis chain
LGTM: Addition of Link component to MDX components
The inclusion of the
Linkcomponent in the returned object ofuseMDXComponentsis correct and consistent with how other components are added. This change should help address the rendering issues mentioned in the PR objectives, particularly for headers containing links.To ensure the
Linkcomponent is being used correctly in the migrated MDX files, please run the following script:This script will help verify that the
Linkcomponent is being utilized in the migrated MDX files and identify any remaining markdown-style links that might need to be converted.
To address the issue with unrecognized
mdxfile types, please use the updated script below:🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Check for usage of the Link component in MDX files # Search for Link usage in MDX files echo "Searching for Link usage in MDX files:" rg --type mdx '\bLink\b' apps/docs # Check for any remaining markdown-style links that should be using the Link component echo "Checking for potential missed Link conversions:" rg --type mdx '\[.*\]\(.*\)' apps/docsLength of output: 527
Script:
#!/bin/bash # Description: Check for usage of the Link component in MDX files # Search for Link usage in MDX files echo "Searching for Link usage in MDX files:" rg '\bLink\b' -g '*.mdx' apps/docs # Check for any remaining markdown-style links that should be using the Link component echo "Checking for potential missed Link conversions:" rg '\[.*\]\(.*\)' -g '*.mdx' apps/docsLength of output: 47943
apps/docs/src/content/docs/knowledge-base/cuHacking-2020-wiki/index.mdx (1)
18-18:
⚠️ Potential issueFix grammatical error in the organization description.
There's a grammatical error in the sentence describing the organization's leadership.
Please apply the following change:
-The cuHacking organization is lead by two <Link href={COLEADS}>Coleads</Link>, and is comprised of seven teams. +The cuHacking organization is led by two <Link href={COLEADS}>Coleads</Link>, and is comprised of seven teams.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.The cuHacking organization is led by two <Link href={COLEADS}>Coleads</Link>, and is comprised of seven teams. You can [find out what they do](https://docs.google.com/document/d/1cD4cH6yS4vdunPDjY2PbOCsy18Uw1TYXwLwQYPhEobo/), or you can click on an individual team's page below.🧰 Tools
🪛 LanguageTool
[grammar] ~18-~18: Make sure that the noun ‘lead’ is correct. Did you mean the past participle “leaded”, “led”?
Context: ... # Teams The cuHacking organization is lead by two Coleads</Li...(BE_VB_OR_NN)
apps/docs/src/content/docs/knowledge-base/cuHacking-2020-wiki/admin-console.mdx (1)
11-21:
⚠️ Potential issueFix typo and LGTM for Account Management section
The Account Management section provides a clear overview of the console's capabilities. However, there's a minor typo that should be corrected:
-The Admin Console will take care of the tasks bellow. +The Admin Console will take care of the tasks below.The rest of the section, including the list of functions, is well-structured and informative.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.The Admin Console will take care of the tasks below. # Account Managements The admin console will have the ability to create/edit/delete user data and list users that are currently in the database. This could include changing a users food group, editing a user's team, etc. #### Functions - Create account - Accept account to hackathon - Generate a paper badge (PDF) for an account, so it may be given to a hacker - View internal hacker information - Information that was provided in their application, or generated info (food group, team, etc.)🧰 Tools
🪛 LanguageTool
[duplication] ~20-~20: Possible typo: you repeated a word
Context: ...iven to a hacker - View internal hacker information - Information that was provided in their application,...(ENGLISH_WORD_REPEAT_RULE)
apps/docs/src/content/docs/knowledge-base/cuHacking-2020-wiki/design.mdx (4)
7-11:
⚠️ Potential issueFix typo and consider reviewing the tone.
There's a typo in the word "efficient" on line 9. Additionally, while the casual tone might be intentional and appealing to the target audience, consider reviewing it to ensure it aligns with the overall documentation style and professionalism expected.
Please apply this fix:
-The ***coolest*** team of cuHacking. We design effcient and creative material, but overall, make things ***look sick***. +The ***coolest*** team of cuHacking. We design efficient and creative material, but overall, make things ***look sick***.Consider rephrasing to maintain enthusiasm while increasing professionalism:
# The Design Team We are the creative force behind cuHacking. Our team designs efficient and visually striking materials, including graphics, swag, marketing content, and web pages.
15-17: 🛠️ Refactor suggestion
Improve header formatting and content structure.
The current format of this section can be improved for better readability and consistency with markdown best practices.
Consider applying these changes:
- Remove the triangle symbol from the header for better compatibility across different markdown renderers.
- Structure the content as a list for improved readability.
Here's a suggested revision:
## Who are we? We are: - Designers - Artists - Developers - Detail-oriented computer science students - Cool people who care about the finer points of designThis structure makes the content more scannable and easier to read while maintaining the essence of the original text.
21-34: 🛠️ Refactor suggestion
⚠️ Potential issueStandardize link formatting and improve content clarity.
There are several areas for improvement in this section:
- Link formatting is inconsistent.
- The specific version of Illustrator might become outdated.
- There's a grammatical issue in the Invision description.
Please apply these fixes:
- Standardize link formatting:
-[Figma](https://www.figma.com/) - this tool will be used as our main way of creating: +[Figma](https://www.figma.com/) - This tool will be used as our main way of creating: -Adobe Illustrator (5.3) +[Adobe Illustrator](https://www.adobe.com/products/illustrator.html) -[Invision](https://www.invisionapp.com/) -- This tool is going to be used as our main way to get feedback from each other and from the organization as it allows to collaborative feedback. +[Invision](https://www.invisionapp.com/) +- This tool will be used as our main way to get feedback from each other and from the organization as it allows for collaborative feedback.
Remove the specific version number for Illustrator to prevent the documentation from becoming outdated.
Correct the grammatical issue in the Invision description.
Consider restructuring the content for better readability:
## Our tools We use the following tools for our design work: ### [Figma](https://www.figma.com/) Our primary tool for creating: - Web designs - Marketing materials - Sponsor materials (Invoices, Packages) ### [Adobe Illustrator](https://www.adobe.com/products/illustrator.html) Used for creating artistic assets, primarily vector graphics. ### [Invision](https://www.invisionapp.com/) Our platform for collaborative feedback, both within the team and across the organization.This structure provides a clearer overview of each tool and its purpose.
🧰 Tools
🪛 LanguageTool
[style] ~31-~31: ‘made out of’ might be wordy. Consider a shorter alternative.
Context: ...ed for creating artistic assets, mostly made out of vector graphics. [Invision](https://ww...(EN_WORDINESS_PREMIUM_MADE_OUT_OF)
[style] ~34-~34: Use ‘will’ instead of ‘going to’ if the following action is certain.
Context: ...tps://www.invisionapp.com/) - This tool is going to be used as our main way to get feedback...(GOING_TO_WILL)
48-61: 🛠️ Refactor suggestion
Standardize link formatting and improve structure.
The team and designs sections are informative, but there are opportunities to improve consistency and structure:
Consider applying these changes:
- Standardize link formatting:
## The team ### Design Lead - [Omar Garcia](https://omargarcia.io) ### Designers - Cara Swab - Ece Yaykiran ## Our designs Find our work on: - [Trello](https://trello.com/b/9t6rNvMZ) - [Google Drive](https://drive.google.com/drive/folders/1icMS1P5_DVENwojE0DjJIf1pkaRPlTg5?usp=sharing) - [Dribbble](https://dribbble.com)These changes improve consistency in link formatting and make the section more readable. The use of a list for the design platforms enhances scannability.
apps/docs/src/content/docs/knowledge-base/cuHacking-2020-wiki/email-template-soliciting-a-high-school-for-judges.mdx (1)
9-24:
⚠️ Potential issueImprove grammar and generalize event-specific information in the email template.
The email template provides comprehensive information about cuHacking. However, consider the following improvements:
Grammar and style:
- Add a comma before "and" in the first sentence of the second paragraph.
- Replace "from different knowledge in coding" with "with different coding knowledge".
- Use "outside the box" instead of "outside of the box".
Generalize event-specific information:
- Remove or generalize the specific dates (January 11 and 12, 2020).
- Update the reference to "Last year" and "This year" to be more general.
Here's a suggested revision for the first paragraph:
- My name is Anoushka and I am a student at Carleton University. I am reaching out to you on behalf of cuHacking hosted by Carleton University on January 11 and 12 2020. + My name is [Your Name], and I am a student at Carleton University. I am reaching out to you on behalf of cuHacking, an annual event hosted by Carleton University.Please review and update the remaining paragraphs similarly, ensuring that all event-specific information is generalized or removed.
Would you like assistance in drafting a fully generalized version of the email template?
Committable suggestion was skipped due to low confidence.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~11-~11: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... Hello Highschool, My name is Anoushka and I am a student at Carleton University. ...(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~13-~13: The preposition “with” seems more likely in this position.
Context: ...thon held over a weekend where students from different knowledge in coding come toge...(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
[uncategorized] ~13-~13: The preposition “of” seems more likely in this position.
Context: ...where students from different knowledge in coding come together and build a projec...(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
[style] ~15-~15: This phrase is redundant. Consider using “outside”.
Context: ...ckathon, we challenge students to think outside of the box with absolutely no hacking invo...(OUTSIDE_OF)
[style] ~17-~17: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ll over Ottawa to attend our hackathon. This is an opportunity for them to not only ...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
apps/docs/src/content/docs/knowledge-base/cuHacking-2020-wiki/how-to-zoho.mdx (1)
7-10: 🛠️ Refactor suggestion
Consider enhancing the introduction for clarity and security.
The introduction provides good context, but consider the following improvements:
- The Google Sheets link might expose sensitive information. Consider moving it to a more secure, internal location or implementing access controls.
- The wording in line 9 could be more concise.
Here's a suggested revision for line 9:
- * Some teams will have personalized aliases for each team member in order to create a more personal relationship between us and sponsors / contacts + * Some teams use personalized aliases for each member to foster personal relationships with sponsors and contacts📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.## Introduction Some teams have their own accounts. You can find all the cuHacking emails [here](https://docs.google.com/spreadsheets/d/1PnAqQ6T-KWycn5anhSFcyLENLTGmqmiIWSRyXMTHdRE/edit?usp=sharing). * Some teams use personalized aliases for each member to foster personal relationships with sponsors and contacts * The inbox is still shared by the team, even with aliases🧰 Tools
🪛 LanguageTool
[style] ~9-~9: Consider a shorter alternative to avoid wordiness.
Context: ...rsonalized aliases for each team member in order to create a more personal relationship bet...(IN_ORDER_TO_PREMIUM)
apps/docs/src/content/docs/knowledge-base/cuHacking-2020-wiki/roadmap.mdx (2)
24-35:
⚠️ Potential issueContent LGTM, but grammatical improvements needed
The Lists section effectively introduces the organization of the roadmap into Notes and Months, which aligns well with the stated goals. However, there are some grammatical issues that should be addressed:
Please consider the following corrections:
- In line 26, restructure the sentence for clarity:
- Since this tool should be useful for retrospecting it is important that the lists not become filled too much with since many tasks will be hidden since only 3-5 cards can be shown at a time. + Since this tool should be useful for retrospecting, it is important that the lists not become overfilled, as many tasks will be hidden when only 3–5 cards can be shown at a time.
- In line 34, consider using an em dash for better readability:
- (every month) + — (every month)These changes will improve the overall readability and professionalism of the document.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.# Lists Since this tool should be useful for retrospecting, it is important that the lists not become overfilled, as many tasks will be hidden when only 3–5 cards can be shown at a time. The lists will be organized into 2 sections: 1. **Notes** - retrospectives - notes 2. **Months** — (every month)🧰 Tools
🪛 LanguageTool
[uncategorized] ~26-~26: Possible missing comma found.
Context: ...s Since this tool should be useful for retrospecting it is important that the lists not beco...(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~26-~26: The negated form ‘not’ seems to be incomplete.
Context: ...specting it is important that the lists not become filled too much with since many ...(DT_NN_NOT_VB)
[typographical] ~26-~26: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...ce many tasks will be hidden since only 3-5 cards can be shown at a time. The list...(HYPHEN_TO_EN)
36-52:
⚠️ Potential issueContent LGTM, with suggestions for clarity and grammar
The Notes and Months subsections effectively describe their purposes and align well with the roadmap goals. However, there are some areas where clarity and grammar can be improved:
Please consider the following suggestions:
- In the retrospective notes section (lines 40-43), improve sentence structure and punctuation:
- This list will be used to write a card every time something occurs that would be useful as a lesson for future years - - It can be when a deadline was missed, you should create a note as to why it was missed and how it could be avoided next time - If something went really well create a note so that we can continue doing the right things + This list will be used to write a card every time something occurs that would be useful as a lesson for future years. + - When a deadline is missed, create a note explaining why it was missed and how it could be avoided in the future. + - If something went really well, create a note so that we can continue doing the right things.
- In the notes section (line 47), consider rewording for clarity:
- This list will be used to write cards with stray thoughts that relate to the roadmap, but are not yet concrete. Consider this the miscellaneous list. + This list will be used for cards containing ideas related to the roadmap that are not yet fully developed. Consider this the miscellaneous list.
- In the Months section (lines 51-52), improve sentence structure:
- These should be where all future and past tasks should be. - This will allow the team to see what is upcoming, as well as see what progress has been made. + This section should contain all future and past tasks. + It will allow the team to see upcoming tasks and track progress that has been made.These changes will enhance the overall clarity and professionalism of the document.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.## Notes ### retrospective notes This list will be used to write a card every time something occurs that would be useful as a lesson for future years. - When a deadline is missed, create a note explaining why it was missed and how it could be avoided in the future. - If something went really well, create a note so that we can continue doing the right things. ### notes This list will be used for cards containing ideas related to the roadmap that are not yet fully developed. Consider this the miscellaneous list. ### Months This section should contain all future and past tasks. It will allow the team to see upcoming tasks and track progress that has been made.🧰 Tools
🪛 LanguageTool
[uncategorized] ~43-~43: A comma might be missing here.
Context: ...ided next time If something went really well create a note so that we can continue d...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~43-~43: A period might be missing here.
Context: ...so that we can continue doing the right things ### notes This list will be used to w...(AI_EN_LECTOR_MISSING_PUNCTUATION_PERIOD)
apps/docs/src/content/docs/knowledge-base/cuHacking-2020-wiki/email-template-inviting-a-professor-to-judge.mdx (1)
25-29:
⚠️ Potential issueFix grammatical error and enhance mentorship information.
There are a few issues in this section that need to be addressed:
- There's a grammatical error in the first sentence.
- A comma is missing after "workshop" in the bullet point.
- The mentorship information could be more detailed.
Please apply the following changes:
- If you are not interested in judging, we also looking for professors to mentor at the event. You will be able to help students overcome challenges in their projects as a mentor, and if you wish you may be able to host a workshop during the event. - * If you wish to host a workshop feel free to contact me with the topic, and if there is space in the schedule we will slot you in. + If you are not interested in judging, we are also looking for professors to mentor at the event. As a mentor, you will be able to: + * Help students overcome challenges in their projects + * Share your expertise and industry insights + * Inspire and guide the next generation of tech professionals + + Additionally, you may have the opportunity to host a workshop during the event. + * If you wish to host a workshop, feel free to contact me with the topic, and if there is space in the schedule, we will slot you in.These changes correct the grammatical error, add the missing comma, and provide more detailed information about the mentorship role, making it more appealing to potential mentors.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.**Mentorship** If you are not interested in judging, we are also looking for professors to mentor at the event. As a mentor, you will be able to: * Help students overcome challenges in their projects * Share your expertise and industry insights * Inspire and guide the next generation of tech professionals Additionally, you may have the opportunity to host a workshop during the event. * If you wish to host a workshop, feel free to contact me with the topic, and if there is space in the schedule, we will slot you in.🧰 Tools
🪛 LanguageTool
[grammar] ~27-~27: An auxiliary verb seems to be missing from this progressive structure. Did you mean “we're also looking”, “we are also looking”, or “we were also looking”?
Context: ... If you are not interested in judging, we also looking for professors to mentor at the event. ...(PRP_VBG)
[uncategorized] ~28-~28: Possible missing comma found.
Context: ...ring the event. * If you wish to host a workshop feel free to contact me with the topic,...(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~29-~29: The phrase ‘feel free to’ is used quite frequently. Consider using a less frequent alternative to set your writing apart from others and make it sound more professional.
Context: ...e in the schedule we will slot you in. Please feel free to contact me if you have any questions or...(FEEL_FREE_TO_STYLE_ME)
apps/docs/src/content/docs/knowledge-base/cuHacking-2020-wiki/design-guide.mdx (3)
51-51:
⚠️ Potential issueFix typo in Feedback loop - Round 2 section.
There's a typo in the word "objective".
Correct the spelling:
-- - The objetive of this stage is to finalize the current stage to move the design to the final stage. ++ - The objective of this stage is to finalize the current stage to move the design to the final stage.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.- The objective of this stage is to finalize the current stage to move the design to the final stage.
13-17:
⚠️ Potential issueCorrect the numbering in the process overview.
There's a numbering inconsistency in the list of process steps. Step 5 is placed before step 4, which could lead to confusion.
Please reorder the steps to maintain a logical sequence:
1. Brainstorm. 2. Draft. 3. Feedback loop. - 5. Draft. - 4. Finalization and Detailing. + 4. Draft. + 5. Finalization and Detailing.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.1. Brainstorm. 2. Draft. 3. Feedback loop. 4. Draft. 5. Finalization and Detailing.
7-7:
⚠️ Potential issueUpdate the brand guide link.
The link to the brand guide is currently a placeholder. Please update it with the correct URL to ensure easy access to the referenced guide.
Replace the placeholder URL with the actual link:
-For reference to the brand guide please visit [link](https://) +For reference to the brand guide please visit [link](https://actual-brand-guide-url.com)Committable suggestion was skipped due to low confidence.
🧰 Tools
🪛 LanguageTool
[typographical] ~7-~7: Consider adding a comma here.
Context: ...system For reference to the brand guide please visit link --- ## ∆ The ...(PLEASE_COMMA)
apps/docs/src/content/docs/knowledge-base/cuHacking-2020-wiki/coding-guidelines.mdx (1)
41-55: 🛠️ Refactor suggestion
Enhance the PR template for more comprehensive descriptions
The provided PR template is a good starting point, covering essential aspects of a pull request. To make it even more effective, consider the following enhancements:
Add the following sections to the PR template:
```markdown # Feature A one line description of the feature being made in the PR. # Description A description of what you had to do to accomplish this feature. - Were there any hiccups? - Did you have to deviate from the origin concept of the feature? - Is this related to any other PRs? (link them here). +# Changes +- List the main changes made in this PR +- Include any new dependencies or packages added + +# Breaking Changes +- List any breaking changes introduced by this PR +- Describe how to migrate from the old behavior to the new behavior + # Tests - How did you test your feature? - What new unit tests did you make? - What are the steps to reproducing your manual tests? + +# Checklist +- [ ] I have added/updated necessary documentation +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] New and existing unit tests pass locally with my changesThese additions will help ensure that PR descriptions are more comprehensive and provide all necessary information for reviewers. </blockquote></details> <details> <summary>apps/docs/src/content/docs/knowledge-base/cuHacking-2020-wiki/application-server.mdx (1)</summary><blockquote> 35-39: _:hammer_and_wrench: Refactor suggestion_ **Consider enhancing the Frameworks Used section.** The Frameworks Used section provides a concise list of the main technologies used in the application server. To improve its informativeness and readability, consider the following suggestions: 1. Add version numbers for node.js and express.js to provide more specific information. 2. Consider adding brief explanations of why these frameworks were chosen for the project. 3. Improve the formatting of the list for better readability. For example: ```markdown ## Frameworks Used The following frameworks and packages are used to create the application server (excluding component-specific packages): - **node.js** (v14.x): The foundation of the entire application, providing the runtime environment. - **express.js** (v4.x): Provides routing capabilities, simplifying the definition of API endpoints.Would you like assistance in expanding this section with more detailed information about the frameworks or their specific use in the project?
apps/docs/src/content/docs/knowledge-base/cuHacking-2020-wiki/postman.mdx (1)
25-28:
⚠️ Potential issueEnhance the "Introduction to Postman" section.
While it's good to link to official Postman resources, this section currently lacks substantial content. The "WIP" marker is appropriate, but more context would be helpful for readers.
Consider the following improvements:
- Provide a brief overview of what users can expect to learn in this section when it's complete.
- If possible, add a few key points about Postman that are particularly relevant to cuHacking projects.
- Expand the "WIP" note to give readers an idea of when they might expect updates.
Here's a suggested expansion:
## Introduction to Postman This section will provide a cuHacking-specific introduction to Postman, including: - Setting up Postman for cuHacking projects - Basic request creation and sending - Using environment variables for different deployment stages For now, [the official site has plenty of resources](https://learning.getpostman.com/getting-started/) if you need to learn to use Postman (i.e., if you're an API developer). > **Note:** This section is a work in progress. We aim to complete it before the next hackathon. In the meantime, feel free to explore the official Postman documentation linked above.This expansion gives readers a clearer idea of what to expect and provides some immediate value while acknowledging the section's incomplete status.
apps/docs/src/content/docs/knowledge-base/cuHacking-2020-wiki/website.mdx (2)
15-23:
⚠️ Potential issueMinor grammatical correction needed.
The content in this section is well-structured and informative. However, there's a small grammatical issue that needs to be addressed.
Please apply the following change:
-The bar at the top of the website should contains links to most of the sections of the site, which would scroll to them when clicked. +The bar at the top of the website should contain links to most of the sections of the site, which would scroll to them when clicked.This correction ensures proper subject-verb agreement with the modal verb "should".
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.# Content The website is a single page web application that consists of sections, each with their own purpose. The content is split into stages, using later stages once we get closer to the hackathon and have more information to display. ### Navigation bar All stages except the promotion stage will have this component. The bar at the top of the website should contain links to most of the sections of the site, which would scroll to them when clicked. ## Stage 1 This is when the team has been formed and cuHacking is being planned. Consists of the date and location. Also can collect emails for a newsletter.🧰 Tools
🪛 LanguageTool
[style] ~16-~16: Consider using a more formal alternative.
Context: ...we get closer to the hackathon and have more information to display. ### Navigation bar All sta...(MORE_INFO)
[grammar] ~19-~19: The modal verb ‘should’ requires the verb’s base form.
Context: ...he bar at the top of the website should contains links to most of the sections of the si...(MD_BASEFORM)
[uncategorized] ~22-~22: A comma may be missing after the conjunctive/linking adverb ‘Also’.
Context: ...ned. Consists of the date and location. Also can collect emails for a newsletter. #...(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
73-76:
⚠️ Potential issueGrammatical correction needed in the Applications section.
The Applications section provides valuable information about the account creation process. However, there's a grammatical issue that needs to be addressed.
Please apply the following change:
-Aspiring hackers will have create an account for the entire cuHacking platform. +Aspiring hackers will have to create an account for the entire cuHacking platform.This correction ensures proper use of the verb "have" in this context.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.# Applications Aspiring hackers will have to create an account for the entire cuHacking platform. This account will be used during the application process, and if they are accepted - to manage a Hacker's access to [Articuno](https://github.com/cuhacking/cuHacking-wiki/wiki/Dashboard) (the Hacker dashboard) and [Latios/Latias](https://github.com/cuhacking/cuHacking-wiki/wiki/Mobile-App) (the mobile apps). When applications first open, the website will have a large 'Apply to cuHacking 2020' button that will lead to account creation, and then to the rest of the application process. The account will require a first name, last name, email address, phone number, and require the user to create a password. Once they are accepted, that same account will be used for registration and _potentially_ team management/creation on the dashboard.🧰 Tools
🪛 LanguageTool
[grammar] ~74-~74: The verb form ‘create’ does not seem to be suitable in this context.
Context: ...Applications Aspiring hackers will have create an account for the entire cuHacking pla...(HAVE_VB)
apps/docs/src/content/docs/knowledge-base/cuHacking-2020-wiki/how-to-slack.mdx (1)
67-95:
⚠️ Potential issueApprove "Formatting" section with minor correction
The "Formatting" section provides clear explanations and examples for various text formatting options in Slack. This will be helpful for users looking to enhance their message presentation.
There's a minor typo in the italics explanation. Please apply the following fix:
-Use the _ symbol before and after some text to bold italicize it. i.e. `\_Italics_` +Use the _ symbol before and after some text to italicize it. i.e. `_Italics_`📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.# Formatting You can format your messages in slack using certain characters, and create bullet point lists. ### **Bold** Use the * symbol before and after some text to bold it. i.e. `*Bold\*` ### _Italics_ Use the _ symbol before and after some text to italicize it. i.e. `_Italics_` ### ~Strikethrough~ Use the ~ symbol before and after some text to bold it. i.e. `~Strikethrough~` ### Lists Use the - symbol followed by a space at the start of a like to create a list item; you can indent a list item by adding two spaces at the start of the line. - This is a list item - This an indented list item This is how you could create the above bullet points: ``` - This a list item - This is an indented list item ```🧰 Tools
🪛 LanguageTool
[uncategorized] ~77-~77: Possible missing comma found.
Context: ... _ symbol before and after some text to bold italicize it. i.e.\_Italics_### ~S...(AI_HYDRA_LEO_MISSING_COMMA)
apps/docs/src/content/docs/knowledge-base/cuHacking-2020-wiki/sponsorship-faqs.mdx (2)
14-14:
⚠️ Potential issueFill in the placeholders with actual information
There are two placeholders that need to be replaced with specific information:
- Line 14: Replace
_**ENTER DATE HERE**_with the actual payment deadline.- Line 29: Replace
_**ENTER WHERE HERE**_with the specific address or location for sending promotional items.Filling in these details will make the FAQ more informative and complete for potential sponsors.
Also applies to: 29-29
48-48:
⚠️ Potential issueReplace company name placeholders and standardize pricing format
- Replace
_**COMPANY**_placeholders with a generic term like "[Your Company]" in lines 48 and 51.- Standardize the pricing format. Currently, there's an inconsistency between "$50" and "00" (presumably $500).
Here's a diff with the suggested changes:
-* If _**COMPANY**_ is interested in hosting an interactive workshop at our event, we'd offer this benefit for an additional 50. +* If [Your Company] is interested in hosting an interactive workshop at our event, we'd offer this benefit for an additional $50. -* _**COMPANY**_ can sponsor a hacking room for an additional 00. This would include a dedicated hacking classroom, located in the atrium of River Building (Richcraft Hall), which will be recognized as "Sponsored by _**COMPANY**_." +* [Your Company] can sponsor a hacking room for an additional $500. This would include a dedicated hacking classroom, located in the atrium of River Building (Richcraft Hall), which will be recognized as "Sponsored by [Your Company]."Also applies to: 51-51
apps/docs/src/content/docs/knowledge-base/cuHacking-2020-wiki/leadership-team-management.mdx (4)
84-86: 🛠️ Refactor suggestion
Consider expanding the Trello section with more details.
The current Trello section is quite brief. To provide more value to readers, consider expanding this section with:
- A brief explanation of what Trello is for those unfamiliar with it.
- Specific examples of how to use Trello for task management in the context of cuHacking.
- Best practices for setting up and maintaining Trello boards for team projects.
For example:
## Trello Trello is a popular project management tool that uses boards, lists, and cards to organize and prioritize tasks. It's particularly useful for tracking upcoming and ongoing tasks, next steps, and who they are assigned to. ### Using Trello for cuHacking: 1. Create a board for each major project or team 2. Use lists to represent different stages of tasks (e.g., "To Do", "In Progress", "Done") 3. Create cards for individual tasks, assigning team members and due dates 4. Use labels to categorize tasks (e.g., "High Priority", "Design", "Development") Remember to regularly update your Trello board and encourage all team members to use it consistently for effective task management.This expansion would provide more practical guidance for readers.
🧰 Tools
🪛 LanguageTool
[duplication] ~84-~84: Possible typo: you repeated a word
Context: ...uced commitment that works for them ## Trello Trello is a useful tool for tracking upcoming ...(ENGLISH_WORD_REPEAT_RULE)
87-95: 🛠️ Refactor suggestion
Enhance the Additional Resources section.
The Additional Resources section provides valuable references. To make it more engaging and useful, consider the following improvements:
- Add a brief introduction explaining the importance of continuous learning in leadership.
- Categorize the resources (e.g., Videos, Books, Podcasts).
- Add a brief description for each resource to help readers decide which ones to prioritize.
Here's an example of how you could restructure this section:
# Additional Resources Effective leadership is a journey of continuous learning. The following resources offer diverse perspectives and practical advice to help you grow as a leader: ## Videos - [How Great Leaders Inspire Action (TED Talk)](https://www.youtube.com/watch?v=qp0HIF3SfI4) Simon Sinek explores how leaders can inspire cooperation, trust, and change. ## Books - [How to Win Friends and Influence People (eBook)](https://drive.google.com/file/d/1VL1TTiZHS4FcO-nBFh2yRhKOB9zy_O3-/view) Dale Carnegie's classic on improving your interactions with others and becoming a more effective leader. ## Podcasts - [WorkLife with Adam Grant](https://www.ted.com/series/worklife_with_adam_grant) Organizational psychologist Adam Grant takes you inside unconventional workplaces to explore ideas that can help us make work more meaningful and creative. Remember, the first step to becoming good at anything is exposing yourself to many ideas about how to do that thing. Explore these resources and apply what you learn to your leadership journey at cuHacking! --- Originally written by Federico NaranjoThis restructuring makes the section more informative and easier to navigate.
72-72:
⚠️ Potential issueFix typo in the Bystander Effect section.
There's a repeated word in this sentence. Here's the correction:
- Oftentimes, it is easy to to `@channel` on slack and ask "who can complete this task?". + Oftentimes, it is easy to `@channel` on Slack and ask "who can complete this task?".This change also capitalizes "Slack" as it's a proper noun.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.Oftentimes, it is easy to `@channel` on Slack and ask "who can complete this task?". Unfortunately this usually does not work due to the bystander effect. Everyone assumes someone else will respond, but in the end no one does.🧰 Tools
🪛 LanguageTool
[duplication] ~72-~72: Possible typo: you repeated a word
Context: ...Bystander Effect Oftentimes, it is easy to to@channelon slack and ask “who can co...(ENGLISH_WORD_REPEAT_RULE)
[typographical] ~72-~72: Consider adding a comma after ‘Unfortunately’ for more clarity.
Context: ... and ask “who can complete this task?”. Unfortunately this usually does not work due to the b...(RB_LY_COMMA)
[style] ~72-~72: Consider replacing this phrase to strengthen your wording.
Context: ... assumes someone else will respond, but in the end no one does. The best way to find some...(IN_THE_END_EVENTUALLY)
12-12:
⚠️ Potential issueFix grammatical issue in team member responsibility description.
There's a minor grammatical issue in the sentence. The singular "team member" is followed by the plural pronoun "them". To maintain consistency, consider the following change:
- It is the **team leader's responsibility** to ensure that the team member knows what is expected of them, how to complete their tasks, and where to ask for help. + It is the **team leader's responsibility** to ensure that team members know what is expected of them, how to complete their tasks, and where to ask for help.This change maintains grammatical consistency and improves readability.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.It is the **team leader's responsibility** to ensure that team members know what is expected of them, how to complete their tasks, and where to ask for help.🧰 Tools
🪛 LanguageTool
[uncategorized] ~12-~12: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...esponsibility** to ensure that the team member knows what is expected of them, how to ...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[uncategorized] ~12-~12: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...bility** to ensure that the team member knows what is expected of them, how to comple...(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
apps/docs/src/content/docs/knowledge-base/cuHacking-2020-wiki/transitions.mdx (4)
118-138: 🛠️ Refactor suggestion
Enhance the Onboarding section with more specific guidance
The Onboarding section provides a good overview of the process. However, there are a few areas that could be improved:
The link to the meeting minutes (line 135) is likely outdated. Consider updating this link or removing the specific year reference to make the document more evergreen.
The section could benefit from more specific guidance on conducting effective onboarding meetings.
Consider adding more detailed information about:
- Recommended duration for onboarding meetings
- Specific topics to cover in each meeting (beyond the general list provided)
- Follow-up actions after the meetings
- Tools or resources to use during onboarding (e.g., onboarding checklists, documentation)
For example, you could add a subsection like this:
### Onboarding Best Practices - Schedule 60-90 minute meetings for each onboarding session - Use a shared onboarding checklist to track progress - Provide access to necessary tools and documentation before the meeting - Follow up with a summary email and next steps after each meeting - Schedule regular check-ins for the first month to address any questions or concernsThese additions would provide more actionable guidance for future team leaders conducting onboarding.
🧰 Tools
🪛 LanguageTool
[typographical] ~122-~122: There might be a comma missing.
Context: ...o lose interest and once you need tasks done they won’t be committed to the team any...(IF_PRP_PRP_COMMA)
139-212: 🛠️ Refactor suggestion
Enhance Tasks and Team Tools sections with security best practices
The Tasks and Team Tools sections provide useful information for setting up team infrastructure. However, there are a few areas that could be improved:
The link to the cuHacking Accounts document (line 153) might contain sensitive information. Consider removing this link from the public documentation and providing it separately to authorized team members.
The section on Google Drive could benefit from more specific instructions.
There's no mention of security best practices for managing shared accounts.
Consider adding the following improvements:
Remove the direct link to the cuHacking Accounts document and replace it with a note about where authorized team members can find this information securely.
Expand the Google Drive section with more specific instructions, such as:
## Google Drive - Create a new folder structure for the current year - Set up appropriate sharing permissions for each folder - Create a standardized naming convention for files and folders - Set up Google Drive File Stream for easy access to shared filesAdd a section on security best practices:
## Security Best Practices - Use a password manager to generate and store strong, unique passwords for each account - Enable two-factor authentication (2FA) on all accounts where possible - Regularly audit account access and remove permissions for former team members - Use role-based access control to limit access to sensitive information - Educate team members on phishing and other security threatsThese additions would improve the overall security posture of the team and provide more comprehensive guidance for setting up and managing team tools.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~141-~141: Did you mean “googles” or “googled”?
Context: ...e later sections. ## Accounts Collect google emails + github usernames collected in ...(NNP_VBP_TO_VBZ)
[grammar] ~141-~141: “Google” is a proper noun and needs to be capitalized.
Context: ...mails + github usernames collected in a google form from all your team members from th...(A_GOOGLE)
[grammar] ~142-~142: “Google” is a proper noun and needs to be capitalized.
Context: ...epeated have to hunt people down. - The google email is needed for trello and google d...(A_GOOGLE)
[grammar] ~142-~142: Did you mean “Google Drive”?
Context: ...e google email is needed for trello and google drive. - The github username is used to add p...(GOOGLE_PRODUCTS)
[style] ~147-~147: Consider a shorter alternative to avoid wordiness.
Context: ...general tasks that need to be completed in order to complete a transition to a new exec tea...(IN_ORDER_TO_PREMIUM)
[style] ~151-~151: Consider a shorter alternative to avoid wordiness.
Context: ...rds Passwords must be reset every year in order to control who has access to which account...(IN_ORDER_TO_PREMIUM)
[uncategorized] ~151-~151: Possible missing comma found.
Context: ...g if someone were to compromise certain accounts such as the [email protected] e...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~161-~161: Possible missing preposition found.
Context: ...g files to new folders It is important reorganize files at the end of the year so that th...(AI_HYDRA_LEO_MISSING_TO)
[duplication] ~161-~161: Possible typo: you repeated a word
Context: ...is also ensures that nothing gets lost, and and so that new team members have an idea o...(ENGLISH_WORD_REPEAT_RULE)
[typographical] ~169-~169: It appears that a comma is missing.
Context: ...ads and the new team leaders. In these meetings you should go over all the responsibili...(DURING_THAT_TIME_COMMA)
[grammar] ~179-~179: This question may be missing the auxiliary verb ‘do’.
Context: ... get out of this experience? - What you think would make a successful cuHacking 2021?...(MISSING_AUX_QS)
[misspelling] ~196-~196: This word is normally spelled as one.
Context: ...w trello team - Create a board for each sub-team - coleads - design ...(EN_COMPOUNDS_SUB_TEAM)
213-230: 🛠️ Refactor suggestion
Enhance the First General Meeting section with facilitation tips
The First General Meeting section provides a good overview of the meeting's goals and topics. However, there are a few areas that could be improved:
The links to previous meeting notes and slides (lines 229-230) are likely outdated. Consider updating these links or removing the specific year references to make the document more evergreen.
The section could benefit from more specific guidance on meeting facilitation.
Consider adding the following improvements:
Replace the specific year references in the links with a more general instruction, such as:
- Refer to the most recent General Meeting Notes in the shared drive - Use the latest General Meeting Slides template as a starting pointAdd a subsection on meeting facilitation tips:
### Meeting Facilitation Tips - Start with an icebreaker activity to help team members get to know each other - Use interactive methods to explain cuHacking's mission and values (e.g., group discussions, quick quizzes) - Demonstrate the team tools (Trello, Slack, Zoho) with live examples - Allow time for Q&A after each major topic - End the meeting with a team-building activity or social time - Follow up with a summary email and any action itemsThese additions would provide more practical guidance for running an effective first general meeting and help ensure that all team members feel included and engaged from the start.
🧰 Tools
🪛 LanguageTool
[style] ~214-~214: Consider a shorter alternative to avoid wordiness.
Context: ...eral Meeting This meeting is important in order to make sure everyone feels like they are ...(IN_ORDER_TO_PREMIUM)
[uncategorized] ~227-~227: Possible missing comma found.
Context: ...o the team; if you wait until after the summer many people will have changed their min...(AI_HYDRA_LEO_MISSING_COMMA)
232-234: 🛠️ Refactor suggestion
Expand the First Directors Meeting section with more detailed guidance
The First Directors Meeting section is currently very brief and lacks specific guidance. This important meeting deserves more detailed coverage to ensure its effectiveness.
Consider expanding this section with the following additions:
- Meeting objectives
- Suggested agenda items
- Pre-meeting preparation
- Follow-up actions
Here's an example of how you could expand this section:
# First Directors Meeting This meeting is crucial for aligning the leadership team and setting the tone for the upcoming year. While organizing during the summer can be challenging due to various commitments, it's important to prioritize this meeting. ## Meeting Objectives - Align on the vision and goals for the upcoming year - Clarify roles and responsibilities - Establish communication protocols - Set initial timelines and milestones ## Suggested Agenda 1. Welcome and introductions (15 minutes) 2. Review of cuHacking's mission and values (20 minutes) 3. Discussion of goals and objectives for the year (45 minutes) 4. Overview of each director's role and responsibilities (30 minutes) 5. Establishment of communication protocols and meeting schedules (20 minutes) 6. Initial timeline and milestone setting (30 minutes) 7. Q&A and open discussion (20 minutes) ## Pre-meeting Preparation - Send out a pre-meeting survey to gather input on goals and challenges - Ask each director to prepare a brief overview of their role and initial plans - Distribute any relevant documents (e.g., previous year's retrospective) in advance ## Follow-up Actions - Send out meeting minutes and action items within 24 hours - Schedule individual follow-ups with each director - Create a shared document for tracking progress on initial goals and milestones Remember to be flexible with scheduling and consider virtual meeting options to accommodate various summer commitments.This expanded section provides more comprehensive guidance for conducting an effective first directors meeting, which is crucial for setting up the team for success in the upcoming year.
apps/docs/src/content/docs/knowledge-base/cuHacking-2020-wiki/mobile-app.mdx (1)
41-67:
⚠️ Potential issueLGTM! Consider prioritizing layout options and fix minor grammatical issue.
The Schedule section provides a comprehensive overview of the feature, including different layout options and the Event Details Screen functionality. The development note offers valuable insights into design considerations.
There's a minor grammatical issue in the reminder description. Apply this fix:
-When the user sets a reminder this way, the reminder will be handled locally using the system's alarm scheduler rather than use push notifications. +When the user sets a reminder this way, the reminder will be handled locally using the system's alarm scheduler rather than using push notifications.Consider prioritizing the layout options based on user experience and development effort. You could add a recommendation for which layout to implement first. For example:
We're starting with the Schedule Layout, as it's the easiest. If we have more time we can explore the others. + +Recommended implementation order: +1. Schedule Layout (easiest to implement, good starting point) +2. Grouped by Time Layout (improved user experience, moderate complexity) +3. Calendar Layout (most intuitive, but highest development effort)This prioritization would help guide the development team in their implementation strategy.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.# Schedule The schedule is another top level destination which displays the schedule of all events/activities/workshops that occur over the duration of the hackathon. It will display in a method similar to Google Calendar's schedule view:  #### Development Note There are three potential designs we should consider for this screen: **Schedule Layout** - In this layout, all events are displayed as a simple list in sequential order based on their starting time. This is similar to the "Schedule" layout in Google Calendar. **Grouped by Time Layout** - In this layout, all events are displayed sequentially by their starting time but are grouped by their starting times. A sticky header would be displayed for each group that indicates the start time. This is similar to the "Schedule" screen in the Google I/O app. **Calendar Layout** - In this view, time is displayed vertically and linearly. Each event is displayed as a box that extends for its duration. This is similar to the "Day" layout in Google Calendar, as well as the layout used on cuHacking 2019's website. It should be noted that this would be the most difficult to implement... but perhaps also the most intuitive.  We're starting with the Schedule Layout, as it's the easiest. If we have more time we can explore the others. Recommended implementation order: 1. Schedule Layout (easiest to implement, good starting point) 2. Grouped by Time Layout (improved user experience, moderate complexity) 3. Calendar Layout (most intuitive, but highest development effort) ### Event Details Screen When a user interacts with a schedule item, it will open up a full screen with more details about an event. This screen can feature a paragraph detailing the event, or a picture related to the event, as well as indicating which sponsors are involved with the event or the names of any speakers who may be running the event. This screen will also have an option to open up the building map to indicate where the event is taking place. There will also be an option given to set a reminder for an event. When the user sets a reminder for an event, they will be prompted to select how long in advance of the even they would like to be notified (5, 10, or 15 minutes). When the user sets a reminder this way, the reminder will be handled locally using the system's alarm scheduler rather than using push notifications. #### Development Note The reminder might just come in a fixed time, for the sake of less taps on the screen.🧰 Tools
🪛 LanguageTool
[uncategorized] ~42-~42: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...gs. # Schedule The schedule is another top level destination which displays the schedule...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[grammar] ~66-~66: Did you mean “fewer”? The noun “taps” is countable.
Context: ...t come in a fixed time, for the sake of less taps on the screen. # Map The map will...(FEWER_LESS)
There was a problem hiding this comment.
Caution
Inline review comments failed to post
🛑 Comments failed to post (37)
apps/docs/src/content/docs/knowledge-base/cuHacking-2020-wiki/coleads.mdx (2)
7-11:
⚠️ Potential issueImprove content and fix potential Link component issue.
There are a few issues with the current content:
- The "Work in progress" message is enclosed in backticks, which will render it as inline code. If this is not intended, remove the backticks.
- The
Linkcomponent is used without being imported, which may cause runtime errors. Ensure that theLinkcomponent is imported correctly.- The content is minimal and doesn't provide much information about "Coleads". Consider adding more context or placeholder text to indicate what kind of information will be included in this document.
Here's a suggested improvement:
- `Work in progress` + # Coleads + + This page is currently a work in progress. It will contain information about Coleads for cuHacking 2020. + + ## Relevant Links <p> <Link href={TRANSITIONS}>Transitions</Link> </p>Don't forget to add the necessary import for the
Linkcomponent at the top of the file.Committable suggestion was skipped due to low confidence.
5-5: 💡 Codebase verification
Missing import for
Linkcomponent.The
Linkcomponent is used incoleads.mdxbut is not imported, which may cause runtime errors.
- File:
apps/docs/src/content/docs/knowledge-base/cuHacking-2020-wiki/coleads.mdx🔗 Analysis chain
Verify the import and usage of
TRANSITIONSandLink.The import statement for
TRANSITIONSis correct, but there are a couple of potential issues:
- The
TRANSITIONSconstant is only used as an href in aLinkcomponent. Consider if this is the intended use or if more context is needed.- The
Linkcomponent is used but not imported. This may cause runtime errors.To check for the
Linkcomponent import and the usage ofTRANSITIONS, run the following script:🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Check for Link import and TRANSITIONS usage echo "Checking for Link import:" rg --type mdx 'import.*Link' apps/docs/src/content/docs/knowledge-base/cuHacking-2020-wiki/ echo "Checking for TRANSITIONS usage:" rg --type mdx 'TRANSITIONS' apps/docs/src/content/docs/knowledge-base/cuHacking-2020-wiki/Length of output: 374
Script:
#!/bin/bash # Check for Link import and TRANSITIONS usage in .mdx files echo "Checking for Link import:" rg 'import\s+.*\s+Link' --glob '*.mdx' apps/docs/src/content/docs/knowledge-base/cuHacking-2020-wiki/ echo "Checking for TRANSITIONS usage:" rg 'TRANSITIONS' --glob '*.mdx' apps/docs/src/content/docs/knowledge-base/cuHacking-2020-wiki/Length of output: 571
apps/docs/src/content/docs/knowledge-base/cuHacking-2020-wiki/sponsorship.mdx (1)
12-13: 💡 Codebase verification
Link component import missing in sponsorship.mdx.
The
Linkcomponent is not imported insponsorship.mdx. Please add the following import statement:import { Link } from '@cuhacking/ui-components'; // Adjust the import path as needed🔗 Analysis chain
Improve internal links and ensure proper imports.
Ensure that the
Linkcomponent is properly imported. Add an import statement if it's not already present in the file:import { Link } from '@cuhacking/ui-components'; // Adjust the import path as neededAdd descriptive text to the links for better accessibility. For example:
<Link href={SIGNATURES}>View Signature Template</Link> <Link href={SPONSORSHIP_FAQS}>Read Sponsor FAQ</Link>Consider adding brief descriptions or context for each link to help users understand what they'll find when clicking.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Verify the Link component import # Check for Link import in the current file rg --type mdx "import.*Link.*from" "apps/docs/src/content/docs/knowledge-base/cuHacking-2020-wiki/sponsorship.mdx" # Check for Link import in a potential common import file (adjust the path as needed) rg --type typescript "export.*Link" "apps/docs/src/components/index.ts"Length of output: 343
Script:
#!/bin/bash # Verify the Link component import in sponsorship.mdx rg "import\s+.*Link\s+from" --glob "*.mdx" "apps/docs/src/content/docs/knowledge-base/cuHacking-2020-wiki/sponsorship.mdx" # Verify if Link is exported from the common components index file rg "export\s+.*Link" --glob "*.ts" "apps/docs/src/components/index.ts"Length of output: 267
Script:
#!/bin/bash # Verify the Link component import in sponsorship.mdx rg "import\s+.*Link\s+from" "apps/docs/src/content/docs/knowledge-base/cuHacking-2020-wiki/sponsorship.mdx" # Search the entire repository for exports of the Link component rg "export\s+.*Link" --glob "*.ts" --glob "*.tsx" .Length of output: 233
apps/docs/src/content/docs/knowledge-base/cuHacking-2020-wiki/getting-started.mdx (1)
13-14:
⚠️ Potential issueUpdate wiki link to reflect new documentation site.
The current link points to the GitHub wiki. Since this content is being migrated to a new documentation site, consider updating this link to point to the new location.
Replace the GitHub wiki link with the new documentation site URL:
-Be sure to bookmark this wiki for easy access. -https://github.com/cuhacking/cuHacking-wiki/wiki +Be sure to bookmark this documentation site for easy access. +[New Documentation Site URL]Committable suggestion was skipped due to low confidence.
apps/docs/src/content/docs/knowledge-base/cuHacking-2020-wiki/index.mdx (4)
6-6: 🛠️ Refactor suggestion
Consider using an absolute import path for better maintainability.
While using constants for links is a good practice, the relative import path
"./constants.ts"might cause issues if the file structure changes in the future. Consider using an absolute import path to improve maintainability and reduce the risk of broken imports during refactoring.For example, you could update the import statement to use an absolute path:
-import {GETTING_STARTED, COLEADS, DESIGN, DEVELOPMENT, HACKER_EXPERIENCE, LOGISTICS, MARKETING, OPERATIONS, SPONSORSHIP} from "./constants.ts" +import {GETTING_STARTED, COLEADS, DESIGN, DEVELOPMENT, HACKER_EXPERIENCE, LOGISTICS, MARKETING, OPERATIONS, SPONSORSHIP} from "@/constants/wiki-links"This assumes you have set up path aliases in your project configuration. If not, consider setting them up for cleaner imports across your project.
Committable suggestion was skipped due to low confidence.
20-34: 🛠️ Refactor suggestion
Refactor team links to improve HTML structure and semantics.
The current structure of the team links uses
<br>tags for spacing and wraps the links in a<p>tag, which is not ideal for semantic HTML. Consider refactoring this section to use a more appropriate list structure.Here's a suggested refactor:
-<p> - <Link href={DESIGN}>Design</Link> - <br></br> - <Link href={DEVELOPMENT}>dev-team</Link> - <br></br> - <Link href={HACKER_EXPERIENCE}>Hacker Experience</Link> - <br></br> - <Link href={LOGISTICS}>Logistics</Link> - <br></br> - <Link href={MARKETING}>Marketing</Link> - <br></br> - <Link href={OPERATIONS}>Operations</Link> - <br></br> - <Link href={SPONSORSHIP}>Sponsorship</Link> -</p> +<ul> + <li><Link href={DESIGN}>Design</Link></li> + <li><Link href={DEVELOPMENT}>dev-team</Link></li> + <li><Link href={HACKER_EXPERIENCE}>Hacker Experience</Link></li> + <li><Link href={LOGISTICS}>Logistics</Link></li> + <li><Link href={MARKETING}>Marketing</Link></li> + <li><Link href={OPERATIONS}>Operations</Link></li> + <li><Link href={SPONSORSHIP}>Sponsorship</Link></li> +</ul>This change improves the semantic structure of the document, making it more accessible and easier to style with CSS if needed.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.<ul> <li><Link href={DESIGN}>Design</Link></li> <li><Link href={DEVELOPMENT}>dev-team</Link></li> <li><Link href={HACKER_EXPERIENCE}>Hacker Experience</Link></li> <li><Link href={LOGISTICS}>Logistics</Link></li> <li><Link href={MARKETING}>Marketing</Link></li> <li><Link href={OPERATIONS}>Operations</Link></li> <li><Link href={SPONSORSHIP}>Sponsorship</Link></li> </ul>
16-18:
⚠️ Potential issueFix grammatical error and improve external link presentation.
The Teams section provides a good overview of the organizational structure. However, there's a grammatical error that needs to be addressed, and the presentation of the external link could be improved.
- Fix the grammatical error:
-The cuHacking organization is lead by two <Link href={COLEADS}>Coleads</Link>, and is comprised of seven teams. +The cuHacking organization is led by two <Link href={COLEADS}>Coleads</Link>, and is comprised of seven teams.
- Consider using the
<Link>component for the external link to maintain consistency and potentially add tracking:-You can [find out what they do](https://docs.google.com/document/d/1cD4cH6yS4vdunPDjY2PbOCsy18Uw1TYXwLwQYPhEobo/), or you can click on an individual team's page below. +You can <Link href="https://docs.google.com/document/d/1cD4cH6yS4vdunPDjY2PbOCsy18Uw1TYXwLwQYPhEobo/" target="_blank" rel="noopener noreferrer">find out what they do</Link>, or you can click on an individual team's page below.This change will make the external link consistent with the internal links and add security attributes for opening in a new tab.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.# Teams The cuHacking organization is led by two <Link href={COLEADS}>Coleads</Link>, and is comprised of seven teams. You can <Link href="https://docs.google.com/document/d/1cD4cH6yS4vdunPDjY2PbOCsy18Uw1TYXwLwQYPhEobo/" target="_blank" rel="noopener noreferrer">find out what they do</Link>, or you can click on an individual team's page below.🧰 Tools
🪛 LanguageTool
[grammar] ~18-~18: Make sure that the noun ‘lead’ is correct. Did you mean the past participle “leaded”, “led”?
Context: ... # Teams The cuHacking organization is lead by two Coleads</Li...(BE_VB_OR_NN)
8-14:
⚠️ Potential issueFix grammatical error and consider adding alt text to links.
The introduction provides valuable information about the wiki's purpose and the tools used in the organization. However, there's a minor grammatical error that needs to be addressed.
- Fix the grammatical error in line 14:
-*New to the team? Check out how to <Link href={GETTING_STARTED}>get started</Link> here.* +*New to the team? Check out how to <Link href={GETTING_STARTED}>get started</Link> here.*
- Consider adding descriptive alt text to the
<Link>component for better accessibility:-*New to the team? Check out how to <Link href={GETTING_STARTED}>get started</Link> here.* +*New to the team? Check out how to <Link href={GETTING_STARTED} alt="Getting Started Guide">get started</Link> here.*This change will improve the experience for users relying on screen readers.
Committable suggestion was skipped due to low confidence.
apps/docs/src/content/docs/knowledge-base/cuHacking-2020-wiki/admin-console.mdx (3)
11-11:
⚠️ Potential issueFix grammatical error in the introduction
There's a minor grammatical error in this line. The word "bellow" should be "below".
Apply this change:
-The Admin Console will take care of the tasks bellow. +The Admin Console will take care of the tasks below.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.The Admin Console will take care of the tasks below.
14-14:
⚠️ Potential issueFix possessive apostrophe in Account Management section
There's a missing apostrophe in the possessive form of "user's".
Apply this change:
-The admin console will have the ability to create/edit/delete user data and list users that are currently in the database. This could include changing a users food group, editing a user's team, etc. +The admin console will have the ability to create/edit/delete user data and list users that are currently in the database. This could include changing a user's food group, editing a user's team, etc.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.The admin console will have the ability to create/edit/delete user data and list users that are currently in the database. This could include changing a user's food group, editing a user's team, etc.🧰 Tools
🪛 LanguageTool
[uncategorized] ~14-~14: It looks like there might be a possessive apostrophe missing. Consider inserting it.
Context: ...database. This could include changing a users food group, editing a user's team, etc....(AI_EN_LECTOR_MISSING_NOUN_POSSESSIVE)
32-32:
⚠️ Potential issueAdd missing period in Data Management section
There's a missing period after "etc" in this line.
Apply this change:
-Possible features might also include a method by which we can perform statistical queries on the database to check different processes (such as who has checked in for food from what groups, etc) but these have yet to be fully planned. +Possible features might also include a method by which we can perform statistical queries on the database to check different processes (such as who has checked in for food from what groups, etc.). but these have yet to be fully planned.Committable suggestion was skipped due to low confidence.
🧰 Tools
🪛 LanguageTool
[style] ~32-~32: In American English, abbreviations like “etc.” require a period.
Context: ...s checked in for food from what groups, etc) but these have yet to be fully planned...(ETC_PERIOD)
apps/docs/src/content/docs/knowledge-base/cuHacking-2020-wiki/development-timeline.mdx (1)
51-51:
⚠️ Potential issueFix typo and clarify the scope of the note.
There's a typo in the final line:
- "Tenative" should be "Tentative"
Additionally, it's unclear whether this note applies to the entire timeline or just the January section. Consider moving this note to the beginning of the document if it applies to the entire timeline, or remove it if it's no longer relevant.
apps/docs/src/content/docs/knowledge-base/cuHacking-2020-wiki/design.mdx (3)
7-11:
⚠️ Potential issueFix typo and consider rewording for clarity.
There's a typo in the word "efficient" on line 9. Also, consider rewording the last sentence for better clarity.
Apply this diff to fix the typo and improve clarity:
-The ***coolest*** team of cuHacking. We design effcient and creative material, but overall, make things ***look sick***. +The ***coolest*** team of cuHacking. We design efficient and creative materials, and overall, make things ***look sick***. -This year we will be designing all the graphics, swag, marketing, and, web pages. +This year we will be designing all the graphics, swag, marketing materials, and web pages.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.# The Design Team The ***coolest*** team of cuHacking. We design efficient and creative materials, and overall, make things ***look sick***. This year we will be designing all the graphics, swag, marketing materials, and web pages.
15-18: 🛠️ Refactor suggestion
Improve readability of the "Who are we?" section.
The current format of this section makes it difficult to read. Consider restructuring it for better clarity.
Apply this diff to improve the readability:
-## ∆ Who are we? +## Who are we? -### Designers. Artists. Developers. Cool people. We care about DETAILS. Computer Science students +We are: +- Designers +- Artists +- Developers +- Computer Science students + +We are cool people who care about DETAILS.Also, consider removing the triangle symbol (∆) from all headers for consistency, unless it's a specific branding requirement.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.## Who are we? We are: - Designers - Artists - Developers - Computer Science students We are cool people who care about DETAILS.
21-34: 🛠️ Refactor suggestion
Improve consistency and grammar in the "Our tools" section.
The information provided is valuable, but the formatting is inconsistent across the tools' descriptions. There's also a minor grammatical issue in the Invision description.
Apply this diff to improve consistency and grammar:
-## ∆ Our tools +## Our tools -[Figma](https://www.figma.com/) - this tool will be used as our main way of creating: +### [Figma](https://www.figma.com/) +This tool will be used as our main way of creating: - Web design - Marketing Material - Sponsor material (Invoices, Package) -Adobe Illustrator (5.3) +### Adobe Illustrator (5.3) +This tool will be used for: - Illustrator will be used for creating artistic assets, mostly made out of vector graphics. -[Invision](https://www.invisionapp.com/) -- This tool is going to be used as our main way to get feedback from each other and from the organization as it allows to collaborative feedback. +### [Invision](https://www.invisionapp.com/) +This tool will be used as our main way to: + +- Get feedback from each other and from the organization +- Enable collaborative feedbackThis restructuring improves readability and consistency across all tool descriptions.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.## Our tools ### [Figma](https://www.figma.com/) This tool will be used as our main way of creating: - Web design - Marketing Material - Sponsor material (Invoices, Package) ### Adobe Illustrator (5.3) This tool will be used for: - Illustrator will be used for creating artistic assets, mostly made out of vector graphics. ### [Invision](https://www.invisionapp.com/) This tool will be used as our main way to: - Get feedback from each other and from the organization - Enable collaborative feedback🧰 Tools
🪛 LanguageTool
[style] ~31-~31: ‘made out of’ might be wordy. Consider a shorter alternative.
Context: ...ed for creating artistic assets, mostly made out of vector graphics. [Invision](https://ww...(EN_WORDINESS_PREMIUM_MADE_OUT_OF)
[style] ~34-~34: Use ‘will’ instead of ‘going to’ if the following action is certain.
Context: ...tps://www.invisionapp.com/) - This tool is going to be used as our main way to get feedback...(GOING_TO_WILL)
apps/docs/src/content/docs/knowledge-base/cuHacking-2020-wiki/email-template-soliciting-a-high-school-for-judges.mdx (1)
9-24:
⚠️ Potential issueRefine email template for clarity, grammar, and generalization.
The email template provides a good structure, but there are several areas for improvement:
Address grammatical issues:
- Add a comma before "and" in compound sentences.
- Use appropriate prepositions ("with" instead of "from", "of" instead of "in").
- Remove redundant phrases like "outside of the box".
Generalize the content to align with the instruction to update/omit 2020-specific information.
Improve clarity and professionalism in some sentences.
Here's a suggested revision:
- Hello Highschool, + Hello [High School Name], - My name is Anoushka and I am a student at Carleton University. I am reaching out to you on behalf of cuHacking hosted by Carleton University on January 11 and 12 2020. + My name is [Your Name], and I am a student at Carleton University. I am reaching out to you on behalf of cuHacking, an annual event hosted by Carleton University. - cuHacking is a hackathon held over a weekend where students from different knowledge in coding come together and build a project. This event allows students who are passionate about technology to come together and learn from each other. + cuHacking is a weekend hackathon where students with diverse coding knowledge come together to build projects. This event allows students who are passionate about technology to collaborate and learn from each other. - cuHacking started in 2017 as Ottawa's first MLH hackathon. Our goal was to create a community of students who share the same passion or want more insight. During this hackathon, we challenge students to think outside of the box with absolutely no hacking involved. We host more than just one event, we host games, activities and talks. This is an opportunity for students to win cool prizes and make real-world connections. + cuHacking, which started in 2017 as Ottawa's first MLH hackathon, aims to create a community of students who share a passion for technology or want to gain more insight. During this hackathon, we challenge students to think creatively, with no actual hacking involved. We host multiple events, including games, activities, and talks. This is an opportunity for students to win prizes and make real-world connections. - Last year, we noticed the lack of high school participants at the event. This year, our goal is to expand this experience to high school students as well. This year, we would like to change that by inviting high school students from all over Ottawa to attend our hackathon. This is an opportunity for them to not only network but learn what they are interested in. + We are expanding this experience to high school students, and we would like to invite students from [High School Name] to attend our hackathon. This is an opportunity for them to network and explore their interests in technology. - We have included our brochure as well. If you have any more questions, feel free to email me. Looking forward to hearing from you soon. + We have included our brochure for more information. If you have any questions, please don't hesitate to email me. I look forward to hearing from you soon. Kind Regards, - Anoushka Singhal + [Your Name] - Operations Team Member + [Your Role] Team MemberThese changes improve the grammar, remove specific dates, and make the content more generic while maintaining the overall structure and intent of the email.
Would you like me to create a GitHub issue to track the task of updating this template for future use?
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.Hello [High School Name], My name is [Your Name], and I am a student at Carleton University. I am reaching out to you on behalf of cuHacking, an annual event hosted by Carleton University. cuHacking is a weekend hackathon where students with diverse coding knowledge come together to build projects. This event allows students who are passionate about technology to collaborate and learn from each other. cuHacking, which started in 2017 as Ottawa's first MLH hackathon, aims to create a community of students who share a passion for technology or want to gain more insight. During this hackathon, we challenge students to think creatively, with no actual hacking involved. We host multiple events, including games, activities, and talks. This is an opportunity for students to win prizes and make real-world connections. We are expanding this experience to high school students, and we would like to invite students from [High School Name] to attend our hackathon. This is an opportunity for them to network and explore their interests in technology. We have included our brochure for more information. If you have any questions, please don't hesitate to email me. I look forward to hearing from you soon. Kind Regards, [Your Name] [Your Role] Team Member🧰 Tools
🪛 LanguageTool
[uncategorized] ~11-~11: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... Hello Highschool, My name is Anoushka and I am a student at Carleton University. ...(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~13-~13: The preposition “with” seems more likely in this position.
Context: ...thon held over a weekend where students from different knowledge in coding come toge...(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
[uncategorized] ~13-~13: The preposition “of” seems more likely in this position.
Context: ...where students from different knowledge in coding come together and build a projec...(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
[style] ~15-~15: This phrase is redundant. Consider using “outside”.
Context: ...ckathon, we challenge students to think outside of the box with absolutely no hacking invo...(OUTSIDE_OF)
[style] ~17-~17: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ll over Ottawa to attend our hackathon. This is an opportunity for them to not only ...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
apps/docs/src/content/docs/knowledge-base/cuHacking-2020-wiki/roadmap.mdx (1)
24-35:
⚠️ Potential issueLGTM: Lists section is well-organized. Minor grammatical fix needed.
The explanation of list organization into Notes and Months sections is clear and logical. However, there's a minor grammatical issue that needs addressing.
Please apply the following change to fix the grammatical issue:
-Since this tool should be useful for retrospecting it is important that the lists not become filled too much with since many tasks will be hidden since only 3-5 cards can be shown at a time. +Since this tool should be useful for retrospecting, it is important that the lists not become too filled, as many tasks will be hidden when only 3-5 cards can be shown at a time.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.# Lists Since this tool should be useful for retrospecting, it is important that the lists not become too filled, as many tasks will be hidden when only 3-5 cards can be shown at a time. The lists will be organized into 2 sections: 1. **Notes** - retrospectives - notes 2. **Months** - (every month)🧰 Tools
🪛 LanguageTool
[grammar] ~26-~26: The negated form ‘not’ seems to be incomplete.
Context: ...specting it is important that the lists not become filled too much with since many ...(DT_NN_NOT_VB)
[typographical] ~26-~26: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...ce many tasks will be hidden since only 3-5 cards can be shown at a time. The list...(HYPHEN_TO_EN)
apps/docs/src/content/docs/knowledge-base/cuHacking-2020-wiki/how-to-google-docs.mdx (1)
7-17: 💡 Codebase verification
Image file not found: google-docs-insert-table-of-contents.png
- The specified image path
/cuhacking-2020-images/google-docs-insert-table-of-contents.pngdoes not exist.- Please add the missing image to the repository or update the image path accordingly.
🔗 Analysis chain
Improve image accessibility and verify image path
- Add descriptive alt text to the image for better accessibility.
- Verify that the image path is correct in the new documentation structure.
Here's a suggested improvement:
<img width="345" - alt="Screen Shot 2019-10-24 at 10 30 31 PM" + alt="Google Docs menu showing how to insert a table of contents" src="/cuhacking-2020-images/google-docs-insert-table-of-contents.png" />🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Verify the existence of the image file fd -t f "google-docs-insert-table-of-contents.png"Length of output: 211
🧰 Tools
🪛 LanguageTool
[grammar] ~11-~11: “Google” is a proper noun and needs to be capitalized.
Context: ... a table of contents directly into your google doc by selecting it from the menu optio...(A_GOOGLE)
apps/docs/src/content/docs/knowledge-base/cuHacking-2020-wiki/email-template-inviting-a-professor-to-judge.mdx (2)
9-13: 🛠️ Refactor suggestion
Consider making the year reference more generic or updateable.
The greeting and introduction are well-structured and informative. However, to make this template more reusable for future events, consider updating the specific year reference. You could use a placeholder or make it more generic.
For example:
- I am David Casciano, a member of the cuHacking Operations team. I would like to invite you to attend cuHacking 2020 on January 11 and 12, as a judge or mentor. + I am [Your Name], a member of the cuHacking Operations team. I would like to invite you to attend cuHacking [YEAR] on [DATE], as a judge or mentor. - cuHacking started in 2017 as Ottawa's first MLH hackathon. From the beginning, our focus has been creating a community of students who are passionate about technology, learning, and teamwork. This year we are expecting over 400 students, from every skill level and field of study. + cuHacking, which started in 2017 as Ottawa's first MLH hackathon, focuses on creating a community of students passionate about technology, learning, and teamwork. This year, we are expecting over [NUMBER] students from various skill levels and fields of study.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.Hello Professor __________, I am [Your Name], a member of the cuHacking Operations team. I would like to invite you to attend cuHacking [YEAR] on [DATE], as a judge or mentor. cuHacking, which started in 2017 as Ottawa's first MLH hackathon, focuses on creating a community of students passionate about technology, learning, and teamwork. This year, we are expecting over [NUMBER] students from various skill levels and fields of study.
15-29:
⚠️ Potential issueAddress grammatical issues and improve clarity in judging and mentorship sections.
The content is informative and well-structured, but there are a few areas for improvement:
- In the mentorship section, there's a grammatical error:
- If you are not interested in judging, we also looking for professors to mentor at the event. + If you are not interested in judging, we are also looking for professors to mentor at the event.
- Consider adding a comma for better readability:
- If you wish to host a workshop feel free to contact me with the topic, and if there is space in the schedule we will slot you in. + If you wish to host a workshop, feel free to contact me with the topic, and if there is space in the schedule, we will slot you in.
- As mentioned earlier, consider rephrasing "feel free to" for a more professional tone:
- If you wish to host a workshop, feel free to contact me with the topic, and if there is space in the schedule, we will slot you in. + If you wish to host a workshop, please contact me with the topic, and if there is space in the schedule, we will include it in the program.These changes will improve the overall clarity and professionalism of the email template.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.Below is more information about judging and mentorship, further information can be found in the attached document. **Judging** We have many volunteers and mentors to help the students tackle any of the challenges of their projects. We are looking to create a diverse group of professors to judge the student's creations at the end of the hackathon. Projects are evaluated based on their novelty, grit, technical skill, and functionality. * Novelty: is it a new original idea? * Grit: how did the team react when they encountered setbacks? * Technical Ability: how advanced is their project (based on student's experience level) * Functionality: How complete and functional is the project? **Mentorship** If you are not interested in judging, we are also looking for professors to mentor at the event. You will be able to help students overcome challenges in their projects as a mentor, and if you wish you may be able to host a workshop during the event. * If you wish to host a workshop, please contact me with the topic, and if there is space in the schedule, we will include it in the program.🧰 Tools
🪛 LanguageTool
[grammar] ~27-~27: An auxiliary verb seems to be missing from this progressive structure. Did you mean “we're also looking”, “we are also looking”, or “we were also looking”?
Context: ... If you are not interested in judging, we also looking for professors to mentor at the event. ...(PRP_VBG)
[uncategorized] ~27-~27: Possible missing comma found.
Context: ... their projects as a mentor, and if you wish you may be able to host a workshop duri...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~28-~28: A comma might be missing here.
Context: ...ring the event. * If you wish to host a workshop feel free to contact me with the topic,...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[style] ~29-~29: The phrase ‘feel free to’ is used quite frequently. Consider using a less frequent alternative to set your writing apart from others and make it sound more professional.
Context: ...e in the schedule we will slot you in. Please feel free to contact me if you have any questions or...(FEEL_FREE_TO_STYLE_ME)
apps/docs/src/content/docs/knowledge-base/cuHacking-2020-wiki/design-guide.mdx (2)
13-17:
⚠️ Potential issueCorrect the numbering of process steps.
The current numbering of steps is out of order. Step 5 is listed before step 4, which may cause confusion.
Please update the list to maintain the correct order:
1. Brainstorm. 2. Draft. 3. Feedback loop. - 5. Draft. - 4. Finalization and Detailing. + 4. Draft. + 5. Finalization and Detailing.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.1. Brainstorm. 2. Draft. 3. Feedback loop. 4. Draft. 5. Finalization and Detailing.
7-7: 💡 Codebase verification
⚠️ Potential issueProvide the correct URL for the brand guide link.
The link to the brand guide in
apps/docs/src/content/docs/knowledge-base/cuHacking-2020-wiki/design-guide.mdxis currently empty. Please update it with the correct URL to ensure users can access the referenced guide.🔗 Analysis chain
Add the actual link to the brand guide.
The link to the brand guide is currently empty. Please update it with the correct URL to ensure users can access the referenced guide.
To check if there's an existing brand guide link in the repository, run:
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Search for potential brand guide links rg --type md --type mdx 'brand\s+guide.*http'Length of output: 75
Script:
#!/bin/bash # Search for potential brand guide links in .md and .mdx files rg 'brand\s+guide.*http' --glob '*.md' --glob '*.mdx'Length of output: 197
🧰 Tools
🪛 LanguageTool
[typographical] ~7-~7: Consider adding a comma here.
Context: ...system For reference to the brand guide please visit link --- ## ∆ The ...(PLEASE_COMMA)
apps/docs/src/content/docs/knowledge-base/cuHacking-2020-wiki/coding-guidelines.mdx (1)
36-55: 🛠️ Refactor suggestion
⚠️ Potential issueFix typo in Pull Requests section and consider enhancing the template.
The Pull Requests section effectively emphasizes the importance of detailed PR descriptions and provides a useful template. However, there's a minor typo that needs to be corrected:
In the introductory paragraph, "down" should be "down to". Here's the correction:
-Making an effective PR is crucial for the team's understanding of everyone's changes. These descriptions should be meticulous- down the commands that you run. Pretend that the person testing the PR doesn't know how to use a computer. +Making an effective PR is crucial for the team's understanding of everyone's changes. These descriptions should be meticulous- down to the commands that you run. Pretend that the person testing the PR doesn't know how to use a computer.Additionally, consider enhancing the PR template by adding a section for "Checklist" or "Ready for review". This can help ensure that all necessary steps have been completed before submitting the PR for review. Here's a suggested addition to the template:
# Checklist - [ ] I have tested this change locally - [ ] I have updated the documentation (if applicable) - [ ] I have added/updated unit tests (if applicable) - [ ] My code follows the project's coding guidelinesThis checklist can be customized based on your team's specific requirements and workflow.
apps/docs/src/content/docs/knowledge-base/cuHacking-2020-wiki/website.mdx (2)
40-41: 🛠️ Refactor suggestion
Enhance "Become a sponsor" section
The "Become a sponsor" section could benefit from more detail to make it more informative and actionable for potential sponsors.
Consider expanding this section with more specific information, such as:
### Become a sponsor A section with details on how to sponsor, including: - Benefits of sponsorship - Sponsorship tiers or packages - Contact information for sponsorship inquiries - Any deadlines or important dates for potential sponsors
73-76:
⚠️ Potential issueImprove grammar and readability in Applications section
The Applications section provides valuable information about the process, but there are a few areas for improvement.
Please apply the following changes to fix the grammar and improve readability:
-Aspiring hackers will have create an account for the entire cuHacking platform. This account will be used during the application process, and if they are accepted - to manage a Hacker's access to [Articuno](https://github.com/cuhacking/cuHacking-wiki/wiki/Dashboard) (the Hacker dashboard) and [Latios/Latias](https://github.com/cuhacking/cuHacking-wiki/wiki/Mobile-App) (the mobile apps). +Aspiring hackers will have to create an account for the entire cuHacking platform. This account will be used during the application process. If accepted, it will also be used to manage a Hacker's access to [Articuno](https://github.com/cuhacking/cuHacking-wiki/wiki/Dashboard) (the Hacker dashboard) and [Latios/Latias](https://github.com/cuhacking/cuHacking-wiki/wiki/Mobile-App) (the mobile apps). -When applications first open, the website will have a large 'Apply to cuHacking 2020' button that will lead to account creation, and then to the rest of the application process. The account will require a first name, last name, email address, phone number, and require the user to create a password. Once they are accepted, that same account will be used for registration and _potentially_ team management/creation on the dashboard. +When applications first open, the website will have a large 'Apply to cuHacking 2020' button that will lead to account creation, followed by the rest of the application process. The account will require a first name, last name, email address, phone number, and a password. Once accepted, that same account will be used for registration and _potentially_ team management/creation on the dashboard.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.# Applications Aspiring hackers will have to create an account for the entire cuHacking platform. This account will be used during the application process. If accepted, it will also be used to manage a Hacker's access to [Articuno](https://github.com/cuhacking/cuHacking-wiki/wiki/Dashboard) (the Hacker dashboard) and [Latios/Latias](https://github.com/cuhacking/cuHacking-wiki/wiki/Mobile-App) (the mobile apps). When applications first open, the website will have a large 'Apply to cuHacking 2020' button that will lead to account creation, followed by the rest of the application process. The account will require a first name, last name, email address, phone number, and a password. Once accepted, that same account will be used for registration and _potentially_ team management/creation on the dashboard.🧰 Tools
🪛 LanguageTool
[grammar] ~74-~74: The verb form ‘create’ does not seem to be suitable in this context.
Context: ...Applications Aspiring hackers will have create an account for the entire cuHacking pla...(HAVE_VB)
apps/docs/src/content/docs/knowledge-base/cuHacking-2020-wiki/how-to-slack.mdx (1)
67-95:
⚠️ Potential issueLGTM! Comprehensive formatting guide with a minor typo.
This section provides a clear and helpful guide to text formatting options in Slack, including bold, italics, strikethrough, and lists. The examples effectively illustrate each formatting option.
There's a minor typo in line 73. Please apply the following change:
-Use the * symbol before and after some text to bold it. i.e. `*Bold\*` +Use the * symbol before and after some text to make it bold. i.e. `*Bold\*`📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.# Formatting You can format your messages in slack using certain characters, and create bullet point lists. ### **Bold** Use the * symbol before and after some text to make it bold. i.e. `*Bold\*` ### _Italics_ Use the _ symbol before and after some text to bold italicize it. i.e. `\_Italics_` ### ~Strikethrough~ Use the ~ symbol before and after some text to bold it. i.e. `~Strikethrough~` ### Lists Use the - symbol followed by a space at the start of a like to create a list item; you can indent a list item by adding two spaces at the start of the line. - This is a list item - This an indented list item This is how you could create the above bullet points: ``` - This a list item - This is an indented list item ```apps/docs/src/content/docs/knowledge-base/cuHacking-2020-wiki/sponsorship-faqs.mdx (5)
14-14:
⚠️ Potential issueFill in the payment deadline.
Please replace
_**ENTER DATE HERE**_with the actual payment deadline for sponsoring cuHacking.
29-29:
⚠️ Potential issueProvide the address for sending promotional items.
Please replace
_**ENTER WHERE HERE**_with the specific address where sponsors should send promotional items for their booths.
23-23:
⚠️ Potential issueFix typos in questions 6 and 13.
There are two minor typos that need correction:
- Line 23: Change "demande" to "demand"
- Line 6: Add a space after the colon in "Burst Fire FAQs:"
Apply this diff to fix the typos:
-### Burst Fire FAQs: +### Burst Fire FAQs: -* Yes. Parking passes will be handed out on demande and are valid for both days. +* Yes. Parking passes will be handed out on demand and are valid for both days.Also applies to: 6-6
48-48:
⚠️ Potential issueFill in company names and amounts in questions 1 and 2.
Please replace the placeholders with appropriate information:
- Replace
_**COMPANY**_with a generic term or the actual company name if applicable.- Fill in the missing amount for sponsoring a hacking room (currently shown as "00").
Also applies to: 51-51
60-60:
⚠️ Potential issueConsider generalizing the delivery address.
The specific address provided for delivering swag items (2 Burlington Crescent K1T3K9) might be sensitive information. Consider replacing it with a more general instruction or a placeholder to be filled in later.
Apply this diff to generalize the address:
-* Our historical attendance is of 400 people which each attendee receiving a swag bag at the start of the event. We expect the 400 items to be delivered to us 2 weeks before the event so we can prepare the bag. Please send all the items at 2 Burlington Crescent K1T3K9. +* Our historical attendance is of 400 people with each attendee receiving a swag bag at the start of the event. We expect the 400 items to be delivered to us 2 weeks before the event so we can prepare the bags. Please send all items to the address provided in your sponsorship agreement.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.* Our historical attendance is of 400 people with each attendee receiving a swag bag at the start of the event. We expect the 400 items to be delivered to us 2 weeks before the event so we can prepare the bags. Please send all items to the address provided in your sponsorship agreement.apps/docs/src/content/docs/knowledge-base/cuHacking-2020-wiki/leadership-team-management.mdx (1)
1-95: 🛠️ Refactor suggestion
Overall: Excellent leadership guide with minor improvements needed
This document provides comprehensive and valuable guidelines for leadership team management. The content is well-structured, covering crucial aspects such as delegation, effective meetings, task assignment, and handling team dynamics. The additional resources section adds value by offering further learning opportunities.
While the document is generally well-written, there are several minor grammatical and stylistic issues throughout that should be addressed to enhance its overall professionalism and readability. These have been pointed out in previous comments.
To further improve the document, consider adding a table of contents at the beginning. This would provide readers with a quick overview of the topics covered and allow for easy navigation to specific sections of interest. You can implement this using MDX syntax, which supports React components. Here's an example of how you might structure it:
import { TableOfContents } from '@components/TableOfContents' # Leadership Team Management <TableOfContents items={[ { title: 'Delegation', href: '#delegation' }, { title: 'Meetings', href: '#meetings' }, { title: 'Assigning Tasks', href: '#assigning-tasks' }, { title: 'Additional Resources', href: '#additional-resources' } ]} /> ... (rest of the document)This addition would enhance the document's usability, especially as it grows in length or complexity.
🧰 Tools
🪛 LanguageTool
[style] ~22-~22: The phrase ‘talk about’ can be informal. To elevate your writing, consider using a more professional alternative.
Context: ...ngs allow for team members to raise and talk about any issues they might be having. An ef...(TALK_ABOUT_DISCUSS)
[grammar] ~35-~35: Did you mean “and”?
Context: ...or use tools like "doodle". ## Running a Meeting An important role of a team lea...(VB_AN_VB_DT)
[typographical] ~43-~43: It seems that a comma is missing.
Context: ...ng what to do next To run an effective meeting it is important to create a meeting age...(IN_ORDER_TO_VB_COMMA)
[grammar] ~43-~43: Possible typo. Did you mean “the” or “everyone”?
Context: ...ting agenda beforehand; this allows for the everyone to stay on track and know what to expec...(DT_PRP)
[uncategorized] ~51-~51: Possible missing comma found.
Context: ... ### Status Updates In this part of the meeting each team member should quickly go over...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~53-~53: When a number forms part of an adjectival compound, use a hyphen.
Context: ...ce no one wants the meeting to become a 2 hour affair. ### Discussion During this per...(MISSING_HYPHEN)
[uncategorized] ~59-~59: Possible missing comma found.
Context: ...re. ### Next Steps At the end of every meeting everyone should know exactly what they ...(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~59-~59: Try using a more formal synonym here to elevate your writing.
Context: ...tasks they are working on, and how they plan on accomplishing it. # Assigning Tasks In order for tas...(PLAN_ON_INTEND)
[uncategorized] ~64-~64: The preposition ‘for’ seems more likely in this position.
Context: ...; this often leads to far too much work on a few people. Organizing cuHacking is a...(AI_HYDRA_LEO_REPLACE_ON_FOR)
[uncategorized] ~64-~64: Possible missing comma found.
Context: ...zing cuHacking is a team effort, and as such tasks should be distributed amongst all...(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~64-~64: The preposition ‘amongst’ is correct, but some people think that it is old-fashioned or literary. A more frequently used alternative is the preposition “among”.
Context: ...and as such tasks should be distributed amongst all team members. ## Owners Every task...(AMONGST)
[uncategorized] ~67-~67: Possible missing comma found.
Context: ... on trello — should have an owner, that is a single person responsible for the com...(AI_HYDRA_LEO_MISSING_COMMA)
[duplication] ~72-~72: Possible typo: you repeated a word
Context: ...Bystander Effect Oftentimes, it is easy to to@channelon slack and ask “who can co...(ENGLISH_WORD_REPEAT_RULE)
[typographical] ~72-~72: Consider adding a comma after ‘Unfortunately’ for more clarity.
Context: ... and ask “who can complete this task?”. Unfortunately this usually does not work due to the b...(RB_LY_COMMA)
[style] ~72-~72: Consider replacing this phrase to strengthen your wording.
Context: ... assumes someone else will respond, but in the end no one does. The best way to find some...(IN_THE_END_EVENTUALLY)
[grammar] ~74-~74: Did you mean the communication tool “Slack” (= proper noun, capitalized)?
Context: ...his can be done in a private message on slack or using@namein your team channel. ...(ON_SKYPE)
[style] ~80-~80: As a shorter alternative for ‘able to’, consider using “can not”.
Context: ...ituation. * Try and figure out why they are not able to fulfil their commitments * Make sure th...(BE_ABLE_TO)
[duplication] ~84-~84: Possible typo: you repeated a word
Context: ...uced commitment that works for them ## Trello Trello is a useful tool for tracking upcoming ...(ENGLISH_WORD_REPEAT_RULE)
apps/docs/src/content/docs/knowledge-base/cuHacking-2020-wiki/transitions.mdx (5)
62-117: 🛠️ Refactor suggestion
Enhance the Exec Applications section with these suggestions
The link to the exec responsibilities document (line 76) is hardcoded. Consider using a more maintainable approach for storing and referencing important links.
The application form questions (lines 92-108) are not consistently formatted. Consider using a consistent formatting style, such as:
1. **Email address** (Google email account) 2. **Who are you?** - First name - Last name - Program - City - Expected Graduation - Do you know anyone on the cuHacking organizing team? 3. **Why should we pick you?** - Which team(s) would you like to be on? - Rank your picks - Do you prefer a leadership role? - What makes you qualified for a leadership position? - What relevant experience do you have? - What would you change / add to cuHacking to make it better? - Will you be on co-op?There's a duplicate "Program" field in the application form questions (lines 97 and 98). Remove one of these entries.
Would you like assistance in implementing these changes?
🧰 Tools
🪛 LanguageTool
[grammar] ~90-~90: The name of this company should be capitalized.
Context: ...d. Application forms can be created on google forms with the following questions: 1....(GOOGLE_PRODUCTS)
[typographical] ~99-~99: It appears that a comma is missing.
Context: ... 5. Program 6. Expected Graduation 7. Do you know anyone on the cuHacking organi...(COMMA_BEFORE_QUESTION_WITH_MD)
[style] ~107-~107: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...relevant experience do you have? 6. What would you change / add to cuHacking to ...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~107-~107: Consider using a shorter alternative to avoid wordiness.
Context: ... would you change / add to cuHacking to make it better? 7. Will you be on coop? Previous ...(MADE_IT_JJR)
[uncategorized] ~112-~112: Did you mean “whom”?
Context: ...adline is past, it is time to decide on who to put into which roles. This is a comp...(WHO_TO_WHOM_TO)
[typographical] ~114-~114: Consider inserting a comma for improved readability.
Context: ...ons. Ask for feedback from team members especially those that personally know the applican...(MISSING_COMMAS)
[uncategorized] ~116-~116: Possible missing comma found.
Context: ...The priority should be on deciding team members since they will have a much larger impa...(AI_HYDRA_LEO_MISSING_COMMA)
145-164: 🛠️ Refactor suggestion
Improve the Tasks section with better structure and link management
Consider restructuring this section to make it more scannable. For example:
## Tasks ### 1. Resetting Passwords - Reset passwords annually for security - Use a password generator for strong passwords - Update the cuHacking Accounts document - Create team-specific account documents ### 2. Migrating Files - Reorganize files at the end of each year - Team leaders responsible for their team folders - Outgoing team leaders should review folder contents with coleadsThe link to the cuHacking Accounts document (line 153) is hardcoded. Consider using a more maintainable approach for storing and referencing important links.
Would you like assistance in implementing these changes or further improving the structure of this section?
🧰 Tools
🪛 LanguageTool
[style] ~147-~147: Consider a shorter alternative to avoid wordiness.
Context: ...general tasks that need to be completed in order to complete a transition to a new exec tea...(IN_ORDER_TO_PREMIUM)
[style] ~151-~151: Consider a shorter alternative to avoid wordiness.
Context: ...rds Passwords must be reset every year in order to control who has access to which account...(IN_ORDER_TO_PREMIUM)
[uncategorized] ~151-~151: Possible missing comma found.
Context: ...g if someone were to compromise certain accounts such as the [email protected] e...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~161-~161: Possible missing preposition found.
Context: ...g files to new folders It is important reorganize files at the end of the year so that th...(AI_HYDRA_LEO_MISSING_TO)
[duplication] ~161-~161: Possible typo: you repeated a word
Context: ...is also ensures that nothing gets lost, and and so that new team members have an idea o...(ENGLISH_WORD_REPEAT_RULE)
184-211: 🛠️ Refactor suggestion
Enhance the Team Tools section with more detailed instructions and improved formatting
Consider expanding this section with more detailed instructions for each tool. Here's a suggested structure:
## Team Tools ### Slack 1. Create new Slack workspace for the organizing team - [How to create a Slack workspace](https://get.slack.help/hc/en-us/articles/206845317-Create-a-Slack-workspace) 2. Create new Slack workspace for the event - Rename the past event workspace to reuse "cuHacking" as a workspace name ### Trello 1. Create a new Trello team 2. Create boards for each sub-team: - Coleads - Design - Development - Hacker Experience - Logistics - Operations - Sponsorship 3. Create a new "Roadmap" board ### Google Drive 1. Have each team lead organize their folder for future reference 2. Move files that don't need regular access to: General > [Previous Years](https://drive.google.com/drive/folders/1bKTqnAXWplsrmd8urZDNJS6ILz9SoalH)This structure provides a clearer, more detailed guide for setting up each tool. Consider adding more specific instructions for each step, such as how to invite team members to Slack and Trello, or how to set up folder structures in Google Drive.
Would you like assistance in expanding this section with more detailed instructions?
🧰 Tools
🪛 LanguageTool
[misspelling] ~196-~196: This word is normally spelled as one.
Context: ...w trello team - Create a board for each sub-team - coleads - design ...(EN_COMPOUNDS_SUB_TEAM)
212-234: 🛠️ Refactor suggestion
Enhance the Meeting sections with consistent detail and improved link management
The links to previous meeting notes and slides (lines 229-230) are hardcoded. Consider using a more maintainable approach for storing and referencing important documents.
The First Directors Meeting section is quite brief compared to the First General Meeting section. Consider expanding it with more details, such as:
- Specific agenda items to cover
- How to prepare for the meeting
- Follow-up actions after the meeting
For consistency, consider using a similar structure for both meeting sections. For example:
## First General Meeting ### Goals - Explain cuHacking's mission and values - Introduce team tools - Discuss team structure - Make everyone feel included and valued ### Key Points to Cover - cuHacking mission statement and values - Team tools: Trello, Slack, Zoho - Team structure - Open discussion ### Timing Schedule as soon as possible to ensure team commitment ## First Directors Meeting ### Goals - Kick off organizational efforts - Align directors on priorities and next steps ### Key Points to Cover - Review of team goals and objectives - Discussion of immediate priorities - Assignment of initial tasks - Schedule for future meetings ### Timing Plan around summer commitments (co-op, vacations, summer school) ### Follow-up Actions - Distribute meeting minutes - Set deadlines for initial tasks - Schedule next meetingWould you like assistance in expanding the First Directors Meeting section or implementing these structural changes?
🧰 Tools
🪛 LanguageTool
[style] ~214-~214: Consider a shorter alternative to avoid wordiness.
Context: ...eral Meeting This meeting is important in order to make sure everyone feels like they are ...(IN_ORDER_TO_PREMIUM)
[uncategorized] ~227-~227: Possible missing comma found.
Context: ...o the team; if you wait until after the summer many people will have changed their min...(AI_HYDRA_LEO_MISSING_COMMA)
139-144: 🛠️ Refactor suggestion
Enhance the Accounts section with more detail and fix grammatical issue
Consider expanding this section with more information about the account collection process. For example, you could include:
- A template for the Google form used to collect information
- The specific permissions granted with these accounts
- The process for revoking access when team members leave
There's a grammatical issue in line 141. Consider revising:
-Collect google emails + github usernames collected in a google form from all your team members from the beginning so that you don't have to repeated have to hunt people down. +Collect Google emails and GitHub usernames in a Google form from all your team members from the beginning so that you don't have to repeatedly hunt people down.Would you like assistance in expanding this section or implementing these changes?
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.## Accounts Collect Google emails and GitHub usernames in a Google form from all your team members from the beginning so that you don't have to repeatedly hunt people down. - The google email is needed for trello and google drive. - The github username is used to add people to the cuHacking team on github so that the developer can work, and so that everyone can add to the wiki.🧰 Tools
🪛 LanguageTool
[uncategorized] ~141-~141: Did you mean “googles” or “googled”?
Context: ...e later sections. ## Accounts Collect google emails + github usernames collected in ...(NNP_VBP_TO_VBZ)
[grammar] ~141-~141: “Google” is a proper noun and needs to be capitalized.
Context: ...mails + github usernames collected in a google form from all your team members from th...(A_GOOGLE)
[grammar] ~142-~142: “Google” is a proper noun and needs to be capitalized.
Context: ...epeated have to hunt people down. - The google email is needed for trello and google d...(A_GOOGLE)
[grammar] ~142-~142: Did you mean “Google Drive”?
Context: ...e google email is needed for trello and google drive. - The github username is used to add p...(GOOGLE_PRODUCTS)
|
🎉 This issue has been resolved in version 1.1.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
🚩 Linked issue
Issue #95
🛠 How does this PR address the issue(s)? How does it solve the problem?
Converted all markdown files from the 2020 wiki into mdx files that can be viewed in our own documentation site.
✍️ Comments
constants.tsfile, I was thinking of have a constant for the folder containing the images<img>instead markdown, which meant fumadocs would not optimize it📸 Screenshots (Original vs Migrated)
Home
Development Timelines
Admin Console
Application Server
Coding Guidelines
Coleads
CUSA Funding Non Tuition Fees
Dashboard
Design Guide
Design
Development Timeline
Development
Email Template Inviting A Professor To Judge
Email Template Soliciting A High School For Judges
Getting Started
Hacker Experience
Hacker FAQs
How to: Google Docs
How to: Google Sheets
How to: Slack
How to: Trello
How to: Wiki
How to: Zoho
Leadership Team Management
Logistics
Map Software
Marketing
Mobile App
Operations
Particles
Postman
Roadmap
Signatures
Sponsorship FAQs
Sponsorship
Transitions
Website
Summary by CodeRabbit
New Features
Bug Fixes
useMDXComponentsfunction to include theLinkcomponent for improved MDX content integration.