refactor(docs-e2e): repair failing suite due to broken selectors #188
Conversation
cheenoxd
requested review from
MFarabi619 and
JeremyFriesenGitHub
as code owners
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the 📝 Walkthrough📝 WalkthroughWalkthroughThe pull request introduces significant modifications to workflow configurations and documentation files across the project. Key changes include updating the GitHub Actions workflows to focus on affected projects for linting and testing, removing specific project builds, and adjusting the Changes
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 49
🧹 Outside diff range and nitpick comments (137)
apps/docs-old/postcss.config.cjs (2)
3-7: Enhance documentation with migration stepsWhile the note about library-specific configuration is helpful, it could be more actionable by including:
- Steps to determine if you need library-specific configuration
- How to safely remove the
postcssConfigoptionConsider expanding the comment like this:
// Note: If you use library-specific PostCSS/Tailwind configuration then you should remove the `postcssConfig` build // option from your application's configuration (i.e. project.json). // // See: https://nx.dev/guides/using-tailwind-css-in-react#step-4:-applying-configuration-to-libraries +// +// To determine if you need library-specific configuration: +// 1. Check if your library has unique styling requirements +// 2. Look for custom Tailwind directives in your library +// +// To remove postcssConfig: +// 1. Open your project.json +// 2. Remove the postcssConfig option from the build target
17-22: Remove commented-out codeThe commented-out default configuration isn't providing additional value since it's well-documented in both PostCSS and Tailwind documentation. Consider removing it to keep the configuration clean and maintainable.
-// module.exports = { -// plugins: { -// tailwindcss: {}, -// autoprefixer: {}, -// }, -// }apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/admin-console.mdx (4)
11-11: Fix typo in introductionChange "bellow" to "below".
-The Admin Console will take care of the tasks bellow. +The Admin Console will take care of the tasks below.
14-21: Fix grammatical issues in Account Management section
- Add possessive apostrophe
- Remove redundant word "information"
-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. -View internal hacker information - - Information that was provided in their application, or generated info (food group, team, etc.) +View internal hacker data + - Information provided in their application, or generated info (food group, 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)
[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)
31-37: Improve the Data Management section
- Add missing period after "etc."
- The Functions list appears incomplete and ends abruptly. Consider adding more details about the query functionality or mark it explicitly as "To be continued..."
-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. #### Functions - Query for accounts (match all criteria or match any criteria) + - Examples of query criteria + - Expected output format + - Usage instructions +_(Section to be expanded with more details)_🧰 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)
1-37: Consider enhancing documentation with practical examplesThe documentation provides a good overview but could be more helpful with:
- Example queries for the Data Management section
- Sample event management scenarios
- Step-by-step guides for common account management tasks
This would make the documentation more actionable for users.
Would you like me to help generate example scenarios and step-by-step guides for each section?
🧰 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)
[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)
[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/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/development-timeline.mdx (2)
33-33: Fix typographical issue in parenthetical expressionAdd a comma before the abbreviation "i.e." for better readability.
-Full website ready (up at Marketing's discretion i.e. once we have sponsors to show) for **Snorlax** +Full website ready (up at Marketing's discretion, i.e., once we have sponsors to show) for **Snorlax**🧰 Tools
🪛 LanguageTool
[typographical] ~33-~33: Consider putting a comma before the abbreviation “i.e.”.
Context: ...- Full website ready (up at Marketing's discretion i.e. once we have sponsors to show) for **Sn...(IE_COMMA)
50-51: Update the tentative status indicatorThe document ends with "* Tenative" which has a typo and might need updating if any dates have been confirmed.
-_* Tenative_ +_* Tentative_apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/getting-started/how-to-google-docs.mdx (5)
1-6: Improve readability with better preposition usageChange "overview into how" to "overview of how" for better grammatical flow.
-_Brief overview into how to best use Google Docs + some tips so it's effective for you and your team._ +_Brief overview of how to best use Google Docs + some tips so it's effective for you and your team._🧰 Tools
🪛 LanguageTool
[uncategorized] ~5-~5: The preposition “of” seems more likely in this position.
Context: ...w to: Google Docs" --- _Brief overview into how to best use Google Docs + some tips...(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
11-11: Capitalize the brand name "Google"Brand names should be properly capitalized.
-Insert a table of contents directly into your google doc by selecting it from the menu options `Insert > Table of Contents`, and then selecting which format you would prefer. +Insert a table of contents directly into your Google doc by selecting it from the menu options `Insert > Table of Contents`, and then selecting which format you would prefer.🧰 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)
23-23: Fix noun number consistencyMake both nouns plural for consistency.
-You can add an outline to your document which appears on the left-hand-side with all the heading and subheadings. +You can add an outline to your document which appears on the left-hand-side with all the headings and subheadings.🧰 Tools
🪛 LanguageTool
[uncategorized] ~23-~23: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...ears on the left-hand-side with all the heading and subheadings. <img width="421" ...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
41-41: Fix grammatical structureRemove the redundant modal verb "will".
-When you select it, the paragraph / text where the cursor is will convert to this format. +When you select it, the paragraph / text where the cursor is converts to this format.🧰 Tools
🪛 LanguageTool
[grammar] ~41-~41: Do not use the modal verb ‘will’ after the verb ‘be’.
Context: ..., the paragraph / text where the cursor is will convert to this format. ## Shortcuts ...(BE_MD)
57-61: Add missing commas for better readabilityAdd commas to properly separate clauses.
-Once you do this, the commented text will be highlighted in yellow and you can add a comment in the dialog box. +Once you do this, the commented text will be highlighted in yellow, and you can add a comment in the dialog box. -If you want to assign a task to someone using comments you can write their email preceded by @. +If you want to assign a task to someone using comments, you can write their email preceded by @.🧰 Tools
🪛 LanguageTool
[uncategorized] ~57-~57: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ented text will be highlighted in yellow and you can add a comment in the dialog box...(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~61-~61: Possible missing comma found.
Context: ... want to assign a task to someone using comments you can write their email preceded by @...(AI_HYDRA_LEO_MISSING_COMMA)
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/marketing/hacker-faqs.mdx (2)
10-20: Reorganize and enhance pre-event informationThe "Leading up to Event" section mixes different types of concerns (logistics, preparation, teams, transportation).
Consider reorganizing this section into clearer subsections:
-### Leading up to Event +### Event Preparation * What should I bring? * Do I need to bring my resume? +* **What hardware/software should I prepare?** + +### Teams & Participation * Do I need a team beforehand? +* **How large can teams be?** +* **Is there a team formation event?** + +### Transportation & Venue * Will you be sending buses? * Is there travel reimbursement? * Where should I show up at? * What time should I show up at?🧰 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)
1-4: Enhance metadata for better documentationThe frontmatter could benefit from additional metadata to improve documentation organization and searchability.
Consider adding these metadata fields:
--- title: Hacker FAQs +description: Frequently asked questions for cuHacking participants +tags: ['faq', 'hackers', 'participants', 'registration', 'logistics'] +lastUpdated: YYYY-MM-DD ---apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/getting-started/how-to-google-sheets.mdx (4)
1-6: Consider enhancing the introduction with target audience and prerequisites.While the introduction provides a brief overview, it could be more helpful by specifying:
- Who this guide is intended for (e.g., team leads, organizers)
- Any prerequisites or required access levels
- Expected outcomes after reading
--- title: "How to: Google Sheets" --- -_Brief overview into how to best use Google Sheets + some tips so it's effective for you and your team._ +_A comprehensive guide for cuHacking organizers on effectively using Google Sheets for team collaboration. This guide covers essential features and best practices to help you manage and analyze data efficiently. No prior Google Sheets experience required._
29-31: Add code examples to enhance understanding.Several sections would benefit from concrete examples:
- The UNIQUE formula section needs a syntax example
- The COUNTIF section should show the actual formula syntax
You can apply formulas to cells using the = symbol followed by the formula name such as `=UNIQUE`. Tooltips will appear showing you what the parameters for the formula are. Formulas allow you to parse and manipulate data so we can draw key insights from it. + +For example: +```sheets +# Get unique values from column A +=UNIQUE(A2:A100) + +# Count occurrences of "Computer Science" in column B +=COUNTIF(B2:B100, "Computer Science") +```Also applies to: 35-35, 43-45
9-9: Fix grammar and readability issues.Several sentences need improvement for clarity and correctness:
- Missing commas after introductory phrases
- Agreement errors
- Run-on sentences
-You can create a table which has rows with alternating colours in `Format > Alternating Colours` after selecting all the cells in your table. +You can create a table with alternating row colors by selecting all cells and navigating to `Format > Alternating Colours`. -You can create conditional formatting which allows you to visualize your data by selecting the cells +You can create conditional formatting, which allows you to visualize your data, by selecting the cells -This formula allows you get all unique values +This formula allows you to get all unique values -For example if you wanted to count +For example, if you wanted to count -but there are time when you want +but there are times when you want -This comes up a lot when comparing +This comes up frequently when comparing -You can use filters on a table to sort and view data easily, for example if you were +You can use filters on a table to sort and view data easily. For example, if you wereAlso applies to: 14-14, 35-35, 45-45, 51-51, 57-57, 61-61
🧰 Tools
🪛 LanguageTool
[style] ~9-~9: Consider shortening this phrase to just ‘whether’, unless you mean ‘regardless of whether’.
Context: ...s will bring up a few options including whether or not your table has a header / footer. This ...(WHETHER)
63-65: Enhance the attribution with additional metadata.Consider adding more context to the attribution:
- When was it originally written?
- What was Federico's role?
- Who has maintained/updated it since?
--- -Originally written by Federico Naranjo +Originally written by Federico Naranjo (Technical Lead, cuHacking 2020) +Last updated: December 2024apps/docs/content/docs/concepts/trunk-based-development.mdx (5)
1-5: Align description with document focusThe current description about Git scaling doesn't reflect the document's primary focus on trunk-based development workflow and practices. Consider revising to better represent the content.
-description: Fun fact, Git doesn't scale for colossal monorepos. +description: A guide to our no-merge, no-squash, rebase-only development workflow.
9-9: Consider moving the callout after the introductionThe rebasing instruction, while important, might be more effective after readers understand the context of trunk-based development.
Consider moving this callout after line 11 where trunk-based development is introduced.
15-22: Polish the motivation sectionThere are several grammatical issues and a typo that should be addressed:
-We hate doing repetitive work and want to let technology do the heavy lifing. +We hate doing repetitive work and want to let technology do the heavy lifting. -Majority of time is generally spent debugging. +The majority of time is generally spent debugging.Also, consider rephrasing "extremely small" to be more professional, such as "currently limited" or "compact".
🧰 Tools
🪛 LanguageTool
[style] ~16-~16: Consider using an extreme adjective for ‘small’.
Context: ...me reliability. - Our core team size is extremely small (three at time of writing). Bandwidth f...(EXTREME_ADJECTIVES)
[misspelling] ~16-~16: Did you mean “at a time”, “at the time”, or “at times”?
Context: ...ore team size is extremely small (three at time of writing). Bandwidth for review labor...(AT_TIME2)
[uncategorized] ~20-~20: A determiner appears to be missing. Consider inserting it.
Context: ... is time spent not shipping features. - Majority of time is generally spent debugging. ...(AI_EN_LECTOR_MISSING_DETERMINER)
[uncategorized] ~20-~20: You might be missing the article “the” here.
Context: ...nt not shipping features. - Majority of time is generally spent debugging. Therefor...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
24-29: Add fallback content for iframeWhile the iframe implementation is good, consider adding fallback content for cases where the iframe fails to load.
<iframe title="Trunk-Based Development Website" className="mt-4 w-full h-[400px] rounded-lg" src="https://trunkbaseddevelopment.com/" - allowFullScreen> + allowFullScreen> + <p>Unable to load Trunk-Based Development website. Visit <a href="https://trunkbaseddevelopment.com/">trunkbaseddevelopment.com</a> directly.</p> </iframe>
1-29: Consider adding practical implementation guidanceThe document effectively explains the "why" but could benefit from adding:
- Step-by-step rebase instructions
- Common scenarios and their solutions
- Examples of good commit messages
- Troubleshooting guide
Would you like me to help draft these additional sections?
🧰 Tools
🪛 LanguageTool
[style] ~16-~16: Consider using an extreme adjective for ‘small’.
Context: ...me reliability. - Our core team size is extremely small (three at time of writing). Bandwidth f...(EXTREME_ADJECTIVES)
[misspelling] ~16-~16: Did you mean “at a time”, “at the time”, or “at times”?
Context: ...ore team size is extremely small (three at time of writing). Bandwidth for review labor...(AT_TIME2)
[uncategorized] ~20-~20: A determiner appears to be missing. Consider inserting it.
Context: ... is time spent not shipping features. - Majority of time is generally spent debugging. ...(AI_EN_LECTOR_MISSING_DETERMINER)
[uncategorized] ~20-~20: You might be missing the article “the” here.
Context: ...nt not shipping features. - Majority of time is generally spent debugging. Therefor...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/coding-guidelines.mdx (4)
5-5: Add comma after 'However' for better readability-At dev-team, we program a lot. However everyone has different programming backgrounds, so to make sure we all stay on the same page this page is being created. +At dev-team, we program a lot. However, everyone has different programming backgrounds, so to make sure we all stay on the same page this page is being created.🧰 Tools
🪛 LanguageTool
[uncategorized] ~5-~5: A comma may be missing after the conjunctive/linking adverb ‘However’.
Context: ...nes --- At dev-team, we program a lot. However everyone has different programming back...(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
13-15: Consider updating extension recommendationsBracket Pair Colorizer 2 is now deprecated as VSCode has built-in bracket pair colorization. Consider adding these essential modern extensions:
- Prettier - Code formatter
- Error Lens - Enhanced error highlighting
- Import Cost - Display import/require package sizes
32-34: Update Git resource links and remove redundancy-- [Connecting your terminal to git](https://help.github.com/en/articles/connecting-to-github-with-ssh) +- [Connecting to GitHub with SSH](https://docs.github.com/en/authentication/connecting-to-github-with-ssh)Consider adding:
- Link to GitHub Flow documentation
- Link to GitHub Actions documentation
- Reference to branch protection rules
🧰 Tools
🪛 LanguageTool
[duplication] ~32-~32: Possible typo: you repeated a word
Context: ... to git. - Connecting your terminal to git - [Git command cheat sheet](https://education....(ENGLISH_WORD_REPEAT_RULE)
41-55: Enhance PR template with additional sectionsThe PR template could be more comprehensive. Consider adding:
- Prerequisites/Dependencies section
- Breaking changes section
- PR requirements checklist
- Deployment considerations
Example additions:
# Prerequisites - [ ] Dependencies updated - [ ] Database migrations required - [ ] Configuration changes needed # Breaking Changes List any breaking changes and migration steps # Checklist - [ ] Tests added and passing - [ ] Documentation updated - [ ] Code follows style guidelines - [ ] Rebased on latest mainapps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/postman.mdx (4)
5-5: Specify which sections are work in progressInstead of a general "Work in progress" tag, specify which sections need completion. This helps readers understand what information is reliable.
-`Work in progress` +> **Note**: The following sections are under development: +> - Introduction to Postman +> - Advanced Testing Scenarios
28-28: Complete the Introduction to Postman sectionThe WIP section should cover:
- Postman workspace organization
- Request methods and parameters
- Environment variables
- Pre-request scripts
- Test scripts basics
Would you like me to help generate content for these topics or create a GitHub issue to track this task?
31-34: Add environment setup details and improve conciseness-In order to run tests made in Postman, you'll need to have the Postman program installed, and have the collection downloaded. It may also come with an environments collection. +To run Postman tests, you need: +1. Postman desktop application +2. Test collection files +3. Environment configuration (if applicable) + +### Environment Setup +1. Configure environment variables +2. Set up authentication tokens +3. Verify API endpoints🧰 Tools
🪛 LanguageTool
[style] ~33-~33: Consider a shorter alternative to avoid wordiness.
Context: ...ion. Postman tests come as JSON files. In order to run them, you just need to open up Post...(IN_ORDER_TO_PREMIUM)
[style] ~33-~33: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...N files. In order to run them, you just need to open up Postman, and import them wi...(REP_NEED_TO_VB)
[uncategorized] ~33-~33: Consider adding a hyphen.
Context: ...collection, you can hit the gear in the top right corner and press "Import" to import tha...(TOP_LEFT_CORNER)
35-37: Add test result interpretation guidelinesThe section explains how to run tests but doesn't cover how to interpret results or debug failures. Consider adding:
- Common test failure scenarios
- Debugging strategies
- Test report interpretation
🧰 Tools
🪛 LanguageTool
[style] ~35-~35: In contexts where ‘if’ is followed by ‘or’, using ‘whether’ may be more appropriate (and formal).
Context: ... is great if your goal is just to check if whatever you're testing works or not. T...(IF_WHETHER)
[style] ~37-~37: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ve more control over which requests you want to run. (For example, you might want to sk...(REP_WANT_TO_VB)
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/getting-started/leadership-team-management.mdx (4)
1-15: Enhance document formatting for better readability.Consider these formatting improvements:
- Add a description field in the frontmatter for better SEO
- Convert the italic text to a proper blockquote for the introduction
- Use bullet points for the responsibilities section
--- title: Leadership Team Management +description: Guidelines and best practices for effective team leadership and management --- -*Just some tips and guidelines on how to lead an effective team.* +> Just some tips and guidelines on how to lead an effective team. # Delegation Leadership is about effective delegation; every good leader recognizes that they cannot do everything by themselves. Effective delegation involves constant communication between the team leader and the person assigned to carry out a task — the task owner. -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. +**Team Leader's Responsibilities:** +- Ensure team members understand expectations +- Provide guidance on task completion +- Make help resources available -It is the **team member's responsibility** to raise any issues they are having, if they cannot continue to work on the task, and to ask for help if they need it. +**Team Member's Responsibilities:** +- Raise issues proactively +- Communicate if unable to continue work +- Ask for help when needed
16-60: Improve writing clarity and professionalism.Several writing improvements are needed:
- Line 22: Replace "talk about" with "discuss" for more professional tone
- Line 43: Add comma after "To run an effective meeting"
- Line 51: Add comma after "In this part of the meeting"
- Line 53: Use hyphen in "2-hour affair"
- Line 59: Add comma after "At the end of every meeting"
-An effective team brings up issues as early as possible, and meetings allow for team members to raise and talk about any issues they might be having. +An effective team brings up issues as early as possible, and meetings allow team members to raise and discuss any issues they might be having. -To run an effective meeting it is important to create a meeting agenda beforehand +To run an effective meeting, it is important to create a meeting agenda beforehand -In this part of the meeting each team member should quickly go over +In this part of the meeting, each team member should quickly go over -since no one wants the meeting to become a 2 hour affair. +since no one wants the meeting to become a 2-hour affair. -At the end of every meeting everyone should know exactly +At the end of every meeting, everyone should know exactly🧰 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)
61-83: Fix technical writing issues.Several technical writing improvements are needed:
- Line 64: Replace "on" with "for" in "work for a few people"
- Line 72: Remove duplicated "to"
- Line 74: Capitalize "Slack" as it's a proper noun
- Line 80: Rephrase "not able to" to "cannot"
-this often leads to far too much work on a few people. +this often leads to far too much work for a few people. -Oftentimes, it is easy to to `@channel` on slack +Oftentimes, it is easy to `@channel` on Slack -Try and figure out why they are not able to fulfil their commitments +Try to figure out why they cannot fulfill their commitments🧰 Tools
🪛 LanguageTool
[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)
[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)
84-95: Clean up tools section and enhance resource descriptions.Consider these improvements:
- Remove duplicate "Trello" word
- Add brief descriptions for each resource to help readers decide which to explore
-## Trello Trello is a useful tool +## Trello +Trello is a useful tool # Additional Resources These are just some books, TED talks, and articles that I've found to be useful. The first step to becoming good at anything, is by being exposed to many ideas about how to do the thing. -* [How Great Leaders Inspire Action (TED Talk)](https://www.youtube.com/watch?v=qp0HIF3SfI4) -* [How to Win Friends and Influence People (eBook)](https://drive.google.com/file/d/1VL1TTiZHS4FcO-nBFh2yRhKOB9zy_O3-/view) -* [WorkLife with Adam Grant (podcast)](https://www.ted.com/series/worklife_with_adam_grant) +* [How Great Leaders Inspire Action (TED Talk)](https://www.youtube.com/watch?v=qp0HIF3SfI4) - Simon Sinek's influential talk on starting with "why" +* [How to Win Friends and Influence People (eBook)](https://drive.google.com/file/d/1VL1TTiZHS4FcO-nBFh2yRhKOB9zy_O3-/view) - Dale Carnegie's classic on interpersonal skills +* [WorkLife with Adam Grant (podcast)](https://www.ted.com/series/worklife_with_adam_grant) - Organizational psychologist explores the science of making work not suck🧰 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)
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/design/design-guide.mdx (2)
51-51: Fix grammatical and typographical issuesSeveral issues need to be addressed:
- Line 51: "objetive" should be "objective"
- Line 24: Add comma after "basis"
- Lines 30 & 63: Add period after "etc." for consistency with American English
Apply these corrections:
- The objetive of this stage is + The objective of this stage is - during a weekly or bi-weekly basis depending on deadlines. + during a weekly or bi-weekly basis, depending on deadlines. - (To see where things are put in a page, etc). + (To see where things are put in a page, etc.). - (PDF, PNG, SVG, etc). + (PDF, PNG, SVG, etc.).Also applies to: 24-24, 30-30, 63-63
67-86: Consider tracking incomplete sectionsThe design system section and its subsections are marked as "Coming soon" without clear ownership or timeline for completion.
Would you like me to create GitHub issues to track the completion of these documentation sections? This would help ensure they don't get overlooked and can be properly prioritized.
apps/docs/app/layout.tsx (1)
6-8: Consider adding more language subsets for internationalization.While Latin subset is sufficient for English, consider adding more subsets if the documentation needs to support other languages in the future.
const jetBrainsMono = JetBrains_Mono({ - subsets: ['latin'], + subsets: ['latin', 'latin-ext', 'cyrillic', 'cyrillic-ext'], })apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/application-server.mdx (8)
5-5: Consider enhancing the project referenceThe GitHub link should be accompanied by a brief description of what Magneton is and its role in the cuHacking ecosystem. This context would help new contributors understand the project's scope better.
-**[project: Magneton](https://github.com/cuhacking/cuHacking-API)** +**Project: Magneton** + +Magneton is cuHacking's API server that powers our event management system. For implementation details, see the [source code](https://github.com/cuhacking/cuHacking-API).
8-8: Fix punctuation in abbreviationAdd a period after "etc" for proper American English usage.
-The application server is the application which transmits data between the front-end (the website and apps) and the back-end (the database, Mailchimp, etc). +The application server is the application which transmits data between the front-end (the website and apps) and the back-end (the database, Mailchimp, etc.).🧰 Tools
🪛 LanguageTool
[style] ~8-~8: In American English, abbreviations like “etc.” require a period.
Context: ... the back-end (the database, Mailchimp, etc). It provides a cross-platform method ...(ETC_PERIOD)
10-10: Enhance REST API descriptionConsider adding details about supported HTTP methods (GET, POST, etc.) and response formats (JSON, XML) to provide more technical context for developers.
-It provides a cross-platform method of accessing the data in the form of a REST API, so that no additional wrappers have to be written for the different platforms. +It provides a cross-platform method of accessing the data through a REST API that supports standard HTTP methods (GET, POST, PUT, DELETE) and returns JSON responses. This standardization eliminates the need for platform-specific wrappers.
13-13: Track the pending endpoints documentationThe "coming soon" note should be tracked as a proper task to ensure it's not forgotten.
Would you like me to create a GitHub issue to track the pending endpoints documentation? This will help ensure this important documentation gets completed.
19-19: Fix typo in Mailchimp sectionThere's a typo in "approriately".
-This section allows for much of the interaction with Mailchimp to be automated. For example, subscribing users to a mailing list should have all the steps done automatically. The website should be able to make a single API call which will handle the data approriately. +This section allows for much of the interaction with Mailchimp to be automated. For example, subscribing users to a mailing list should have all the steps done automatically. The website should be able to make a single API call which will handle the data appropriately.
33-33: Use more confident languageRemove "somewhat" to make the statement more definitive.
-The routes of the application server define the endpoint, and which controller function corresponds to it. That's it. The entire file should look somewhat like just the list of endpoints, meaning that there should be no logic in the routes at all. +The routes of the application server define the endpoint, and which controller function corresponds to it. That's it. The entire file should be structured as a clean list of endpoints, with no logic in the routes at all.🧰 Tools
🪛 LanguageTool
[style] ~33-~33: Qualifiers like “somewhat” can weaken your message and make your writing sound uncertain. Consider removing it or choosing an alternative to sound more confident.
Context: ... That's it. The entire file should look somewhat like just the list of endpoints, meanin...(SOMEWHAT)
22-22: Consider archiving external referenceThe link to the Fractal design article on codeburst.io might become unavailable in the future. Consider archiving it using a service like web.archive.org.
-The application server's structure was inspired by the Fractal design laid out [in this page](https://codeburst.io/fractal-a-nodejs-app-structure-for-infinite-scale-d74dda57ee11), as well as the typical MVC architecture. +The application server's structure was inspired by the Fractal design ([original article](https://codeburst.io/fractal-a-nodejs-app-structure-for-infinite-scale-d74dda57ee11), [archived version](https://web.archive.org/web/*/https://codeburst.io/fractal-a-nodejs-app-structure-for-infinite-scale-d74dda57ee11)), as well as the typical MVC architecture.
38-39: Enhance framework descriptionsConsider adding version requirements and more detailed explanations of why these frameworks were chosen.
-* node.js - node.js is the base of the entire application -* express.js - express provides routers, which provides an easy way of defining all the endpoints of the API +* node.js (>= 14.x) - Chosen as our runtime environment for its robust ecosystem, excellent package management, and strong community support +* express.js (>= 4.x) - Selected for its minimalist web framework approach, middleware support, and efficient routing capabilities that align with our REST API requirementsapps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/index.mdx (5)
5-5: Consider using absolute imports for better maintainability.Using relative imports (
../constants.ts) can become problematic if the documentation structure changes. Consider using absolute imports from the root of the project.-import { CODING_GUIDELINES, WEBSITE, DASHBOARD, MOBILE_APP, APPLICATION_SERVER, ADMIN_CONSOLE, MAP_SOFTWARE, POSTMAN } from '../constants.ts' +import { CODING_GUIDELINES, WEBSITE, DASHBOARD, MOBILE_APP, APPLICATION_SERVER, ADMIN_CONSOLE, MAP_SOFTWARE, POSTMAN } from '@/docs/constants'
15-15: Remove or update the crossed-out timeline comment.The informal comment about the private timeline doesn't add value to the documentation and could be removed entirely.
-~~*The rough [Timeline]() for completion.*~~ This page is difficult to maintain, so I'm keeping it private 😅 -Wal
21-25: Standardize link formatting throughout the document.The document mixes custom
<Link>components with markdown links. Consider standardizing to one approach for better maintainability.-<Link href={WEBSITE}>Snorlax</Link> - The main website: [cuhacking.com](https://cuhacking.com) +<Link href={WEBSITE}>Snorlax</Link> - The main website: <Link href="https://cuhacking.com">cuhacking.com</Link>
29-29: Consider using a dynamic asset path for the diagram.The hardcoded image path
/cuhacking-2020-images/cuplatform-diagram.pngmight break if assets are reorganized. Consider using a configurable asset path.- +
56-56: Fix the email link formatting.The email link is missing the
mailto:prefix which helps users open their default email client.-[[email protected]]([email protected]) +[[email protected]](mailto:[email protected])apps/docs-old/tailwind.config.js (3)
1-8: Uncomment type imports for better TypeScript supportThe commented imports appear to be necessary:
- The Config type import would provide better TypeScript support
- The fontFamily import will be needed if you plan to use the commented font configuration in line 23
-// import type { Config } from 'tailwindcss' -// const { fontFamily } = require('tailwindcss/defaultTheme') +import type { Config } from 'tailwindcss' +import { fontFamily } from 'tailwindcss/defaultTheme'
27-36: Clean up commented preset optionsMultiple preset options are commented out, which could lead to confusion. If 'catppuccin' is the final choice:
- Remove the commented preset options
- Document why 'catppuccin' was chosen (if significant)
export const presets = [ createPreset({ - // preset: 'default', - // preset: 'neutral', - // preset: 'dusk', - // preset: 'purple', - // preset: 'ocean', preset: 'catppuccin', }), ]
37-37: Consider adding useful Tailwind pluginsThe empty plugins array is fine if no additional functionality is needed. However, consider adding common documentation-specific plugins like:
@tailwindcss/typographyfor better prose styling@tailwindcss/formsfor form elementsapps/docs/content/docs/concepts/conventional-commits.mdx (3)
24-24: Improve sentence clarity and punctuation.Consider adding a comma before "and" to improve readability.
-With time, writing conventional commit messages will become second nature and you'll no longer need to use Commitizen :) +With time, writing conventional commit messages will become second nature, and you'll no longer need to use Commitizen :)🧰 Tools
🪛 LanguageTool
[uncategorized] ~24-~24: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ommit messages will become second nature and you'll no longer need to use Commitizen...(COMMA_COMPOUND_SENTENCE)
33-33: Improve grammar in exception clause.Add missing article and rephrase for better clarity.
-- Only exception to this is if the commit already existed on the `main` branch, in which case a fixup commit should be made rather than an amend. +- The only exception to this is if the commit already existed on the `main` branch, in which case a fixup commit should be made rather than an amendment.🧰 Tools
🪛 LanguageTool
[uncategorized] ~33-~33: Possible missing article found.
Context: ...e commit history clean and concise. - Only exception to this is if the commit alre...(AI_HYDRA_LEO_MISSING_THE)
[grammar] ~33-~33: The verb ‘amend’ does not usually follow articles like ‘an’. Check that ‘amend’ is spelled correctly; using ‘amend’ as a noun may be non-standard.
Context: ...fixup commit should be made rather than an amend. If that commit is amended and force pu...(A_INFINITIVE)
36-36: Fix preposition and reduce wordiness.Add missing preposition "to" after "allows us" and consider rephrasing the ending for conciseness.
-The slight learning curve of writing conventional commits is well worth the effort. It allows us unlock some pretty powerful DevOps which saves the entire team a lot of time in the long run. +The slight learning curve of writing conventional commits is well worth the effort. It allows us to unlock powerful DevOps capabilities that save the entire team significant time.🧰 Tools
🪛 LanguageTool
[grammar] ~36-~36: The preposition ‘to’ may be missing (allow someone to do something).
Context: ... is well worth the effort. It allows us unlock some pretty powerful DevOps which saves...(ALLOW_TO_DO)
[uncategorized] ~36-~36: Possible missing comma found.
Context: ...t allows us unlock some pretty powerful DevOps which saves the entire team a lot of ti...(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~36-~36: ‘in the long run’ might be wordy. Consider a shorter alternative.
Context: ...ich saves the entire team a lot of time in the long run. ### Decision Tree To ease the proces...(EN_WORDINESS_PREMIUM_IN_THE_LONG_RUN)
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/mobile-app.mdx (5)
5-5: Add version badges and build status indicatorsConsider adding version badges and build status indicators for both repositories to help developers quickly assess the current state of the projects.
Example:
[](https://github.com/cuhacking/cuHacking-iOS/releases) [](https://github.com/cuhacking/cuHacking-android/releases)
29-30: Add technical implementation details for WiFi connectivityThe documentation mentions WiFi network joining functionality but doesn't specify the technical requirements:
- iOS requires Network Extension entitlement and configuration profile
- Android requires ACCESS_FINE_LOCATION permission for Android 9+ and CHANGE_WIFI_STATE permission
Consider adding these implementation details to help developers understand the required setup.
92-98: Add security best practices for authenticationThe authentication implementation needs more detailed security guidelines:
- Implement secure storage for credentials
- Use HTTPS for all API calls
- Implement token refresh mechanism
- Handle session expiration
- Implement rate limiting for login attempts
- Consider implementing biometric authentication
Add a security section detailing these implementation requirements to ensure consistent security practices across both platforms.
🧰 Tools
🪛 LanguageTool
[grammar] ~93-~93: The word “popup” is a noun. The verb is spelled with a space.
Context: ...r fullscreen, depending on design) will popup asking them to sign in. The sign in scr...(NOUN_VERB_CONFUSION)
[uncategorized] ~93-~93: A comma might be missing here.
Context: ...n in. The sign in screen will be pretty simple simply featuring a username and passwor...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[typographical] ~93-~93: Two consecutive dots
Context: ...d also be provided for walk-in attendees.. Note: Single-use login emails for walk-...(DOUBLE_PUNCTUATION)
[uncategorized] ~95-~95: A comma might be missing here.
Context: ...atform’s autocomplete or authentication systems which will make the sign in process eas...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~95-~95: The noun “sign-in” is spelled with a hyphen.
Context: ...hentication systems which will make the sign in process easier. One idea was to offer ...(SIGN_UP_HYPHEN)
123-125: Add theme management implementation detailsThe dark mode implementation needs more technical guidance:
- Define color palette for both themes
- Implement theme switching without activity/view controller recreation
- Handle system theme changes
- Persist theme preference
Add technical implementation details to ensure consistent theme management across both platforms.
🧰 Tools
🪛 LanguageTool
[style] ~123-~123: Consider a shorter alternative to avoid wordiness.
Context: ...be slightly different for the dark mode in order to maintain appropriate and accessible con...(IN_ORDER_TO_PREMIUM)
131-134: Add feature flag implementation detailsThe feature rollout strategy needs technical implementation guidance:
- Recommend a feature flag service (e.g., Firebase Remote Config)
- Define feature flag naming convention
- Implement fallback values
- Handle offline scenarios
Add technical implementation details to ensure reliable feature flag management.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~131-~131: Possible missing comma found.
Context: ...sider publishing the app roughly a week beforehand containing only the Information Screen ...(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~132-~132: ‘During the course of’ might be wordy. Consider a shorter alternative.
Context: ...back later!” (or something like that). During the course of the week, these features can be enabled...(EN_WORDINESS_PREMIUM_DURING_THE_COURSE_OF)
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/index.mdx (1)
20-34: Consider using a more semantic HTML structureInstead of using multiple
<br>tags, consider using a more semantic HTML structure like an unordered list for better accessibility and maintainability.-<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>apps/docs/content/docs/contribution-guidelines/authoring-documentation.mdx (5)
1-5: Consider improving the description and removing "WIP".The current description "Bridge the gap between your brain and the rest of us. WIP." is informal and indicates incomplete content. Consider a more professional description that clearly states the purpose of this guide.
--- title: Authoring Documentation -description: Bridge the gap between your brain and the rest of us. WIP. +description: Guidelines and best practices for writing clear and effective documentation. icon: PencilLine ---
9-12: Consider revising the callout message and placement.The current callout about rebasing seems out of place in a documentation authoring guide. Consider either:
- Moving this to a more appropriate location (e.g., git workflow or PR guidelines)
- Rephrasing it to be more professional and relevant to documentation authoring
<Callout> - Think you're ready for the big leagues? Prove it by rebasing onto `main` - before continuing work. + Before contributing documentation, ensure your branch is up-to-date by rebasing + onto the `main` branch. </Callout>
32-35: Consider varying sentence structure for better readability.The consecutive bullet points starting with "Use" create repetition. Consider restructuring these guidelines for better flow while maintaining clarity.
-- Use **bold** to allow skimming. -- Use **Lists** to express key points instead of using English connectives. -- Use **Tables** to express different things like conditions, and properties. +- Enhance readability with **bold** text for easy skimming. +- Express key points with **Lists** instead of using English connectives. +- Organize complex information in **Tables** to clarify conditions and properties.🧰 Tools
🪛 LanguageTool
[style] ~34-~34: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...instead of using English connectives. - Use Tables to express different things ...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
37-44: Add context to the code snippet example.The code snippet could benefit from additional explanation about its purpose and the highlighting syntax used.
Consider adding a brief explanation before the code block:
### Code Block Examples When sharing code examples, use syntax highlighting and special annotations: - Highlight specific lines with `// [!code highlight]` - Show additions with `// [!code ++]` - Show deletions with `// [!code --]` - Highlight specific words with `// [!code word:example]` ```ts title="Code Snippet Example"
1-53: Consider expanding the documentation guidelines.While the current content provides a good foundation, consider adding these essential sections:
- Documentation structure and organization
- Writing style and tone guidelines
- Examples of good vs. poor documentation
- Common documentation patterns (tutorials, how-tos, references)
- Tips for maintaining documentation
Would you like assistance in drafting content for these additional sections?
🧰 Tools
🪛 LanguageTool
[style] ~34-~34: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...instead of using English connectives. - Use Tables to express different things ...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/getting-started/how-to-trello.mdx (5)
8-8: Improve clarity and grammar in the introduction.The sentence structure could be improved for better readability.
-This year we want to use trello to help us track the minutiae of tasks that it takes to organize such a large event. We have about 30 organizers and we need some system to track who is assigned to what, and to ensure that no tasks fall between the cracks – as often happened last year. +We use Trello to track the numerous tasks involved in organizing this large event. With approximately 30 organizers, we need a system to track task assignments and ensure nothing falls through the cracks – a challenge we faced last year.🧰 Tools
🪛 LanguageTool
[uncategorized] ~8-~8: Possible missing comma found.
Context: ...nd your team._ ## Why use Trello? This year we want to use trello to help us track ...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~8-~8: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...large event. We have about 30 organizers and we need some system to track who is ass...(COMMA_COMPOUND_SENTENCE)
33-35: Standardize terminology and formatting.For consistency and correctness, "todo" should be written as "to-do" throughout the document.
-**Ideally:** todo –> ready –> in progress –> done +**Ideally:** to-do → ready → in progress → done -**Unideal:** todo –> ready –> in progress –> blocked –> in progress –> done +**Unideal:** to-do → ready → in progress → blocked → in progress → done🧰 Tools
🪛 LanguageTool
[grammar] ~33-~33: It appears that a hyphen is missing in the noun “to-do” (= task) or did you mean the verb “to do”?
Context: ...hould be left –> right. Ideally: todo –> ready –> in progress –> done **Unid...(TO_DO_HYPHEN)
[grammar] ~35-~35: It appears that a hyphen is missing in the noun “to-do” (= task) or did you mean the verb “to do”?
Context: ...dy –> in progress –> done Unideal: todo –> ready –> in progress –> blocked –> i...(TO_DO_HYPHEN)
91-92: Fix grammar and improve clarity.Add missing comma and improve sentence structure.
-The most important part of ensuring a task gets done, is to define what the task is, and what each of the steps are to complete it. The best way to do this is by adding a description to each card. Therefore a description is required for each card. +The most important part of ensuring a task gets done is defining the task and its completion steps. The best way to do this is by adding a description to each card. Therefore, a description is required for each card.🧰 Tools
🪛 LanguageTool
[uncategorized] ~91-~91: A comma may be missing after the conjunctive/linking adverb ‘Therefore’.
Context: ...s by adding a description to each card. Therefore a description is required for each card...(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
153-166: Standardize product names and improve integration instructions.Ensure consistent capitalization of product names and provide clearer integration steps.
-## Linking Google Drive Files -You can link your google drive to trello which allows you to browse and add google drive files to a card, using what trello calls a Power-Up. +## Linking Google Drive Files +You can link your Google Drive to Trello, which allows you to browse and add Google Drive files to a card using what Trello calls a Power-Up. -## Linking to Slack -You can also link slack to trello using a Power-Up, in much the same way as the google drive Power-Up. +## Linking to Slack +You can also link Slack to Trello using a Power-Up, similar to the Google Drive Power-Up.🧰 Tools
🪛 LanguageTool
[grammar] ~153-~153: Did you mean “Google Drive”?
Context: ...ng Google Drive Files You can link your google drive to trello which allows you to browse an...(GOOGLE_PRODUCTS)
[uncategorized] ~153-~153: Possible missing comma found.
Context: ...Files You can link your google drive to trello which allows you to browse and add goog...(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~153-~153: Did you mean “Google Drive”?
Context: ...ello which allows you to browse and add google drive files to a card, using what trello call...(GOOGLE_PRODUCTS)
[grammar] ~162-~162: Did you mean “Google Drive”?
Context: ...) _For more information on how to link google drive to trello, see this [website](https://h...(GOOGLE_PRODUCTS)
[grammar] ~165-~165: Did you mean “Google Drive”?
Context: ...a Power-Up, in much the same way as the google drive Power-Up. For more information see this...(GOOGLE_PRODUCTS)
177-202: Improve keyboard shortcuts presentation.Consider organizing shortcuts in a more structured format and clarify platform-specific differences.
-`q` - -Quickly shows only the cards assigned to you. -* Very useful to reduce clutter and focus on only your tasks +## Common Keyboard Shortcuts + +| Key | Description | +|-----|-------------| +| `q` | Show only cards assigned to you (reduces clutter) | +| `d` | Add due dates while hovering over a card | +| `a` | Assign members while hovering over a card | +| `/` | Focus search bar | +| `Space` | Toggle self-assignment on hovered card | +| `⌘/Ctrl + C` | Copy card link (while hovering) | +| `?` | Show keyboard shortcuts panel |🧰 Tools
🪛 LanguageTool
[grammar] ~183-~183: Before the countable noun ‘for’ an article or a possessive pronoun is necessary.
Context: ...asksdAdd deadlines / due-dates for card while hovering your mouse over it.a...(IN_NN_CC_VBG)
[uncategorized] ~199-~199: Possible missing preposition found.
Context: ...ll the shortcuts in case you forgot how trigger one. ### More keyboard shortcuts If yo...(AI_HYDRA_LEO_MISSING_TO)
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/operations/email-template-soliciting-a-high-school-for-judges.mdx (1)
1-24: Consider implementing a template management systemTo make the email templates more maintainable and consistent, consider:
- Using a template engine (e.g., Handlebars, Nunjucks) to manage variable content
- Creating a configuration file for event-specific details
- Implementing a validation system to ensure all required fields are populated before use
This would help prevent outdated information from being sent and make the templates easier to maintain across years.
Would you like assistance in setting up a template management system?
🧰 Tools
🪛 LanguageTool
[style] ~4-~4: 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: ...oliciting a High School for Judges --- Please feel free to use the template below when emailing Hi...(FEEL_FREE_TO_STYLE_ME)
[style] ~5-~5: ‘any and all’ might be wordy. Consider a shorter alternative.
Context: ...ntire text and make sure to update/omit any and all 2020 event specific information_; this ...(EN_WORDINESS_PREMIUM_ANY_AND_ALL)
[uncategorized] ~5-~5: When ‘event-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...ke sure to update/omit any and all 2020 event specific information_; this information has been...(SPECIFIC_HYPHEN)
[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/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/particles.mdx (2)
1-3: Consider enhancing frontmatter metadataAdding metadata fields like
description,tags, andlastUpdatedwould improve documentation discoverability and maintenance tracking.--- title: Particles.js +description: "Documentation for Particles.js integration in cuHacking projects" +tags: ["frontend", "animation", "library"] +lastUpdated: "2024-12" ---
12-12: Fix hyphenation in "up-to-date"The phrase should be hyphenated when used as a compound modifier.
-For more up to date information +For more up-to-date information🧰 Tools
🪛 LanguageTool
[uncategorized] ~12-~12: It appears that hyphens are missing in the adjective “up-to-date”.
Context: ...ly incompatible is IE 6, 7, 8. For more up to date information on canvas support, [take a ...(UP_TO_DATE_HYPHEN)
apps/docs/content/docs/concepts/clean-code.mdx (2)
17-37: Enhance keyword descriptions with specific examplesThe keywords table is well-structured, but consider enhancing these descriptions with concrete examples:
- TODO: Add an example timeline or priority
- HACK: Include when it should be revisited
- OPTIMIZE: Mention specific performance metrics
52-53: Expand the Variable Naming Conventions sectionThe section is marked as WIP and only covers constants. Consider adding conventions for:
- Class names
- Interface names
- Function/method names
- Variable names
- Private/protected members
Would you like me to help draft the complete naming conventions section?
apps/docs/content/docs/glossary.mdx (1)
1-17: Consider adding more common terms and expanding descriptionsThe general terms section could be enhanced by:
- Adding more common terms like:
- EOD (End of Day)
- EOW (End of Week)
- ASAP (As Soon As Possible)
- Expanding descriptions with examples or context
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/map-software.mdx (5)
1-8: Improve terminology precision and compound adjectivesThe introduction effectively outlines the key components, but could benefit from some refinements:
Apply these changes for better clarity and correct grammar:
-For our maps, there will be two main visual components: the basemap, and our custom building layers. +For our maps, there will be two main visual components: the base-map and our custom-building layers.🧰 Tools
🪛 LanguageTool
[misspelling] ~5-~5: This word is normally spelled with a hyphen.
Context: ...visual components: the basemap, and our custom building layers. The basemap will be used to dis...(EN_COMPOUNDS_CUSTOM_BUILDING)
[misspelling] ~5-~5: This word is normally spelled with a hyphen.
Context: ..., and other immediate surroundings. Our custom building layers will show the floor plans of the...(EN_COMPOUNDS_CUSTOM_BUILDING)
9-23: Excellent technical overview, minor grammar improvements neededThe Mapbox integration section provides comprehensive technical guidance. Consider these minor grammatical improvements:
-Mapbox produces various tools and open source libraries +Mapbox produces various tools and open-source libraries -They also provide similar open source SDKs +They also provide similar open-source SDKs🧰 Tools
🪛 LanguageTool
[uncategorized] ~11-~11: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...mapbox.com/) produces various tools and open source libraries for creating and displaying M...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~11-~11: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...playing maps. They also provide similar open source SDKs for [Android](https://docs.mapbox....(EN_COMPOUND_ADJECTIVE_INTERNAL)
29-35: Strong theming approach, minor text improvement neededThe styling section effectively outlines the theming strategy while maintaining flexibility for future design updates.
-These themes are clean, minimalistic, and really good looking. +These themes are clean, minimalistic, and really good-looking.🧰 Tools
🪛 LanguageTool
[misspelling] ~31-~31: This word is normally spelled with a hyphen.
Context: ...mes are clean, minimalistic, and really good looking. Our custom layers will be featured on...(EN_COMPOUNDS_GOOD_LOOKING)
36-58: Well-structured geometry and properties documentationThe technical implementation details are comprehensive and accurate. Consider adding a JSON example of a feature to make the property structure even clearer.
59-87: Comprehensive development notes with style improvements neededThe development notes provide valuable implementation guidance. Consider these writing improvements:
-we will provide a overlaid selection bar +we will provide an overlaid selection bar -using all of the polygon data +using all polygon data -At this point in time (mid-July) +At this time (mid-July) -Another thing to take into consideration +Another considerationAlso, consider adding a comma after "Currently" at the start of sentences.
🧰 Tools
🪛 LanguageTool
[style] ~74-~74: Consider a shorter alternative to avoid wordiness.
Context: ...popup-on-click/). ### Floor Selection In order to allow users to select which floor they'...(IN_ORDER_TO_PREMIUM)
[misspelling] ~75-~75: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...or they'd like to view, we will provide a overlaid selection bar on the top right...(EN_A_VS_AN)
[style] ~77-~77: Consider removing “of” to be more concise
Context: ...th only a FillLayer and LineLayer using all of the polygon data that we have. Currently w...(ALL_OF_THE)
[uncategorized] ~78-~78: A comma may be missing after the conjunctive/linking adverb ‘Currently’.
Context: ... all of the polygon data that we have. Currently we will only need to handle displaying ...(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[style] ~80-~80: This phrase is redundant. Consider writing “At this point”, “At this time”, or “now”.
Context: ...erent floor selection considerations. At this point in time (mid-July) we won't worry about the qua...(AT_THIS_POINT_IN_TIME)
[style] ~83-~83: The phrase “take into consideration” may be wordy. To make your writing clearer, consider replacing it.
Context: ...ween several of them. Another thing to take into consideration when determining how to load the `.geoj...(TAKE_INTO_CONSIDERATION)
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/getting-started/how-to-slack.mdx (4)
11-11: Maintain consistent capitalization of "Slack""Slack" is a proper noun and should be capitalized throughout the document.
-You can use some keywords in a slack message either to get people's attention, point them to a specific channel. +You can use some keywords in a Slack message either to get people's attention, point them to a specific channel.🧰 Tools
🪛 LanguageTool
[grammar] ~11-~11: Did you mean the communication tool “Slack” (= proper noun, capitalized)?
Context: ...eywords You can use some keywords in a slack message either to get people’s attentio...(ON_SKYPE)
85-88: Fix grammatical errors in list descriptionThere are two issues in the list description:
- "like" should be "line"
- Missing "is" in the indented list item
-Use the - symbol followed by a space at the start of a like to create a list item +Use the - symbol followed by a space at the start of a line to create a list item - - This an indented list item + - This is an indented list item🧰 Tools
🪛 LanguageTool
[uncategorized] ~88-~88: Possible missing comma found.
Context: ...of the line. - This is a list item - This an indented list item This is how you ...(AI_HYDRA_LEO_MISSING_COMMA)
115-122: Fix typos and maintain consistent capitalizationFound the following issues:
- "google" should be capitalized as "Google"
- "dooblebot" appears to be a typo for "doodlebot"
-You can link your own google account to the slack workspace +You can link your own Google account to the Slack workspace -You can use @dooblebot to create and share doodle polls +You can use @doodlebot to create and share Doodle polls🧰 Tools
🪛 LanguageTool
[grammar] ~115-~115: “Google” is a proper noun and needs to be capitalized.
Context: ...ing Google Drive You can link your own google account to the slack workspace in order...(A_GOOGLE)
[style] ~122-~122: Consider a shorter alternative to avoid wordiness.
Context: ...blebot to create and share doodle polls in order to find time slots that work for most peop...(IN_ORDER_TO_PREMIUM)
151-151: Fix grammar in instructionsChange "Copy paste" to "Copy and paste" for better readability.
-Copy paste either of these into the text box +Copy and paste either of these into the text box🧰 Tools
🪛 LanguageTool
[grammar] ~151-~151: Did you mean “Copy and paste”?
Context: ...e themes that match our colour schemes. Copy paste either of these into the text box to us...(COPY_PASTE)
apps/docs/content/docs/concepts/conventional-branch.mdx (2)
1-5: Consider using a more professional description.The current description uses a casual tone with a spaghetti reference. Consider revising it to be more descriptive and professional, for example: "Learn about our Git branch naming conventions and workflow practices."
16-22: Enhance examples for better clarity and inclusivity.Consider the following improvements:
- Use a more generic placeholder like
<username>instead of "johndoe"- Add examples for edge cases, such as:
- Branches with multiple word issue names
- Special character handling
- Multiple issue references
-For example, the branch for issue #1 titled 'feat(portal): add login page' would be: `johndoe/feat/1-add-login-page`. +For example: +- Issue #1 'feat(portal): add login page' → `<username>/feat/1-add-login-page` +- Issue #2 'fix: handle special & chars' → `<username>/fix/2-handle-special-chars` +- Issue #3 'feat: implement OAuth 2.0' → `<username>/feat/3-implement-oauth-2-0`apps/docs/app/home/layout.tsx (1)
5-11: LGTM! Consider adding prop types documentation.The layout component is well-structured and properly typed. Consider adding JSDoc comments to document the props for better maintainability.
+/** + * Home layout component that wraps content with fumadocs HomeLayout + * @param {Object} props - Component props + * @param {ReactNode} props.children - Child elements to render within the layout + */ export default function Layout({ children, }: { children: ReactNode }): React.ReactElement {apps/docs/app/layout.config.tsx (3)
21-28: Consider enhancing the documentation comments.While the current comments provide basic guidance, consider adding more details about:
- Available configuration options and their purposes
- Examples of common customizations
- Impact of changes on different layouts
32-33: Address the TODO comment about CMS integration.The comment indicates a plan to use a CMS for the navigation title. Consider creating a tracking issue for this enhancement.
Would you like me to create a GitHub issue to track the CMS integration task?
51-112: Consider security and maintainability improvements for external links.Several improvements could enhance the security and maintainability of external links:
- Add
rel="noopener noreferrer"to external links- Consider moving URLs to a centralized configuration file
- Add type safety for link configurations
Example implementation:
interface ExternalLink { text: string; url: string; icon: React.ReactNode; type?: 'icon'; } const EXTERNAL_URLS = { WEBSITE: 'https://cuhacking.ca', PORTAL: 'https://portal.cuhacking.ca', // ... other URLs } as const; const links: ExternalLink[] = [ { text: 'Website', url: EXTERNAL_URLS.WEBSITE, icon: <LandingPageIcon />, }, // ... other links ].map(link => ({ ...link, target: '_blank', rel: 'noopener noreferrer' }));apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/co-leads/transitions.mdx (3)
1-6: Consider enhancing the frontmatter metadata.The document could benefit from additional metadata fields to improve documentation organization and searchability.
--- title: Transitions +description: "A comprehensive guide for transitioning to a new executive team" +tags: ["documentation", "process", "leadership"] +lastUpdated: "2024" ---
32-33: Fix formatting inconsistencies in the feedback questions.Several formatting issues need to be addressed for better readability:
-4. **Did you feel like the director or the team was disorganized?** - - Were your tasks unclear or were you left with no delegation from the director? What changes could have been made to improve this (such as smaller teams, more specific roles for coordinators, better communication from directors, etc) -5. **Make any open comments about each of the following departments.** - - Feel free to touch on any topic, and you're open to comment on a department you were not a part of. You can talk about your personal experience, or what you would change if you could. +4. **Did you feel like the director or the team was disorganized?** + - Were your tasks unclear or were you left with no delegation from the director? What changes could have been made to improve this (such as smaller teams, more specific roles for coordinators, better communication from directors, etc.)? +5. **Please provide feedback about each department:** + - You may comment on any department, including those you weren't part of + - Consider sharing your experience and suggestions for improvementAlso applies to: 35-37
🧰 Tools
🪛 LanguageTool
[style] ~32-~32: In American English, abbreviations like “etc.” require a period.
Context: ...s, better communication from directors, etc) 5. **Did a director or team member eve...(ETC_PERIOD)
125-130: Improve formatting of onboarding meeting topics.The list of meeting topics should be formatted consistently with other lists in the document.
-**These meetings should cover:** - - Duties and responsibilities - - How to carry out tasks - - Common issues + how to solve them - - How to best organize a team +**These meetings should cover:** +1. Duties and responsibilities +2. Task execution procedures +3. Common issues and solutions +4. Team organization best practicesapps/docs/app/(docs)/[[...slug]]/page.tsx (1)
43-43: Remove commented-out code to keep the codebase cleanThe line
/* lastUpdate={new Date()} */is commented out. IflastUpdateis no longer needed, consider removing this line to maintain a clean codebase.apps/docs-e2e/src/docs.spec.ts (4)
27-30: Address TODO comments to improve test coverageThere are TODO comments indicating tests that are commented out until the links become available. To enhance test coverage:
- If the links are now available, uncomment the tests and update the URLs.
- If not, consider mocking the links or using placeholders to enable testing.
Would you like assistance in updating these tests or setting up mocks to ensure comprehensive test coverage?
Also applies to: 107-111, 113-114, 118-120
68-68: Ensure consistent capitalization of 'GitHub'In test descriptions and strings, 'GitHub' should be capitalized correctly. Currently, 'Github' is used, which is inconsistent.
Apply this diff to correct the capitalization:
- test(`should contain 'Edit on Github' button`, async ({ docsLayoutPage }) => { + test(`should contain 'Edit on GitHub' button`, async ({ docsLayoutPage }) => { ... - test(`should load index page when 'Edit on Github' is clicked`, async ({ docsLayoutPage }) => { + test(`should load index page when 'Edit on GitHub' is clicked`, async ({ docsLayoutPage }) => {Also applies to: 72-72
233-233: Correct the typo in test descriptionThe word 'visability' is misspelled. It should be 'visibility'.
Apply this diff to fix the typo:
- test(`should check for sidebar 'overview' visability`, async ({ docsLayoutPage }) => { + test(`should check for sidebar 'overview' visibility`, async ({ docsLayoutPage }) => {
285-289: Complete the test for 'Edit on GitHub' button functionalityThere's a FIXME comment indicating that the test needs to be completed to verify the 'Edit on GitHub' button links to the correct file. Completing this test will improve test accuracy and coverage.
Would you like assistance in writing this test to ensure the 'Edit on GitHub' button navigates to the appropriate GitHub file?
apps/docs-e2e/src/example.spec.ts (1)
7-7: Enhance the test by using more specific selectorsThe current test uses
page.locator('h1'), which may not be specific enough. Consider usinggetByRoleor adding accessible names to improve test robustness.For example:
- expect(await page.locator('h1').textContent()).toContain('Overview') + expect(await page.getByRole('heading', { level: 1, name: /Overview/ })).toBeVisible()apps/docs-old/specs/index.spec.tsx (1)
6-11: Consider adding more comprehensive tests for thePagecomponentThe current test only checks that the component renders successfully. To ensure the
Pagecomponent works as intended, consider adding tests that verify its content, behavior, and interactions.For example, you could test if specific elements are rendered:
it('should display the page title', () => { const { getByText } = render(<Page />) expect(getByText('Expected Page Title')).toBeInTheDocument() }).github/workflows/BUILD.yml (2)
20-20: Consider keeping shallow clone for faster checkoutsSetting
fetch-depth: 0fetches the complete repository history, which can slow down the workflow. Unless the full history is needed for affected project detection, consider keeping it as 1.
37-44: Document the rationale for commented-out sectionsConsider adding comments explaining why these sections are commented out or remove them if they're no longer needed.
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/dashboard.mdx (3)
17-17: Fix grammatical issues for better readabilitySeveral grammatical improvements are needed:
- Line 17: Change "couple sections" to "couple of sections"
- Line 24: Add hyphen to "logged-in users"
- Line 30: Consider rephrasing "details for the event" to "details about the event"
Also applies to: 24-24, 30-30
🧰 Tools
🪛 LanguageTool
[grammar] ~17-~17: Using ‘couple’ without ‘of’ is considered to be informal.
Context: ...vent The actual Dashboard. Split into a couple sections which can be reached by visiting differ...(PLENTY_OF_NOUNS)
35-39: Add more details to WIP sectionsThe Hardware Checkout and Mini-events sections are marked as WIP. Consider:
- Adding a brief description of planned functionality
- Listing any dependencies or integration points
- Including expected completion timeline
20-21: Consider adding technical implementation detailsFor the countdown feature, consider adding:
- Technical requirements for the fixed navigation implementation
- Any specific UI/UX considerations
- Integration points with other components
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/getting-started/cusa-funding-non-tuition-fees.mdx (2)
5-5: Grammar: Fix "opt-out" vs "opt out" usageThe term "opt-out" is incorrectly used as a verb throughout the document. When used as a verb, it should be "opt out".
Apply these corrections:
-...we can now opt-out of certain student fees... +...we can now opt out of certain student fees... -...we are able to opt-out of funding CUSA... +...we are able to opt out of funding CUSA... -...clubs that apply for funding, do not opt-out of CUSA's... +...clubs that apply for funding, do not opt out of CUSA's... -...select which fees you want to opt-out of. +...select which fees you want to opt out of.Also applies to: 11-11, 13-13, 20-20, 24-24
🧰 Tools
🪛 LanguageTool
[grammar] ~5-~5: The word “opt-out” is a noun. The verb is spelled with a space.
Context: ...’s Student Choice Initiative we can now opt-out of certain student fees, but this can a...(NOUN_VERB_CONFUSION)
13-13: Style: Simplify wordy phrasesReplace "in order to" with "to" for more concise writing.
Apply these changes:
-In order to ensure that their funding... +To ensure that their funding... -In order to opt out of other fees... +To opt out of other fees... -in order to receive any funding... +to receive any funding...Also applies to: 20-20, 36-36
🧰 Tools
🪛 LanguageTool
[grammar] ~13-~13: The word “opt-out” is a noun. The verb is spelled with a space.
Context: ...at clubs that apply for funding, do not opt-out of CUSA’s Clubs and Societies fee: - _...(NOUN_VERB_CONFUSION)
apps/docs/content/docs/contribution-guidelines/coding-standards/end-to-end-testing.mdx (2)
3-3: Update the description fieldThe description is currently marked as "WIP". Please provide a meaningful description that outlines the purpose and scope of the E2E testing guidelines.
43-46: Enhance screen sizes documentationThe screen sizes section would benefit from specific viewport dimensions for each device type. Consider adding:
- Exact viewport dimensions for Desktop
- Specific dimensions for Tablet
- Already includes Mobile (320px)
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/constants.ts (1)
1-40: Consider organizing constants into logical groupsThe file would be more maintainable if constants were grouped by their related sections (e.g., getting-started, dev-team, etc.).
Consider organizing like this:
/* Base URL */ export const CUHACKING_2020_WIKI_URL = '/knowledge-base/cuHacking-2020-wiki' /* Getting Started */ export const GETTING_STARTED = { INDEX: `${CUHACKING_2020_WIKI_URL}/getting-started`, SLACK: `${CUHACKING_2020_WIKI_URL}/getting-started/how-to-slack`, // ... other getting started URLs } /* Development */ export const DEVELOPMENT = { INDEX: `${CUHACKING_2020_WIKI_URL}/dev-team`, TIMELINE: `${CUHACKING_2020_WIKI_URL}/dev-team/development-timeline`, // ... other development URLs } // ... other sectionsapps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/getting-started/how-to-wiki.mdx (2)
39-39: Fix grammatical issuesThere are a few grammatical issues to address:
- Line 39: Remove duplicate "the"
- Line 70: Capitalize "Google" in "google doc"
Apply these corrections:
-Label your commit with the the format +Label your commit with the format-put it in a google doc +put it in a Google docAlso applies to: 70-70
🧰 Tools
🪛 LanguageTool
[duplication] ~39-~39: Possible typo: you repeated a word
Context: ...oad-page.png) - Label your commit with the the format `Upload file1.png, file2.png, fi...(ENGLISH_WORD_REPEAT_RULE)
26-54: Add image guidelines sectionThe image upload section would benefit from guidelines about:
- Recommended image formats (PNG, JPG, etc.)
- Maximum file size limits
- Image resolution recommendations
- Naming conventions for uploaded files
🧰 Tools
🪛 LanguageTool
[uncategorized] ~31-~31: Possible missing comma found.
Context: ...g-wiki/tree/master/resources) - On this page you'll see a button labeled `Upload fil...(AI_HYDRA_LEO_MISSING_COMMA)
[duplication] ~39-~39: Possible typo: you repeated a word
Context: ...oad-page.png) - Label your commit with the the format `Upload file1.png, file2.png, fi...(ENGLISH_WORD_REPEAT_RULE)
apps/docs/content/docs/concepts/monorepo-architecture.mdx (3)
12-13: Remove redundant linkThe link to monorepo.tools is redundant since it's followed by an iframe showing the same content.
-[Monorepos Explained](https://monorepo.tools/)
25-27: Consider expanding principles with brief explanationsThe principles would be more helpful with brief explanations or examples. For instance:
- "Everything is a trade-off" - What are common trade-offs in monorepo architecture?
- "Why is more important than how" - How does this apply to monorepo decisions?
- "Maintain Loose Coupling and High Cohesion" - What are practical examples in the context of this monorepo?
29-110: Consider adding descriptions for empty foldersSeveral folders in the visualization are shown empty (e.g.,
.github,.husky,docs-e2e). Consider either:
- Adding example files to show what typically goes in these folders, or
- Adding brief descriptions using comments to explain their purpose
apps/docs/content/docs/contribution-guidelines/coding-standards/index.mdx (3)
9-15: Improve clarity in the prefaceThe preface could be clearer with more specific examples. Consider adding concrete examples of trade-offs in the context of coding standards.
22-25: Fix grammar and improve clarity
- Add missing comma:
-We're huge on clean code. Code will be read more than it is written. Thankfully you don't have to memorize all of the conventions +We're huge on clean code. Code will be read more than it is written. Thankfully, you don't have to memorize all of the conventions
- Consider adding a specific example of an ESLint rule and how to fix it to make the guidance more actionable.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~22-~22: Possible missing comma found.
Context: ...e will be read more than it is written. Thankfully you don't have to memorize all of the c...(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~22-~22: Consider removing “of” to be more concise
Context: .... Thankfully you don't have to memorize all of the conventions, as most of them have been ...(ALL_OF_THE)
59-99: Add a code example alongside the mathematical exampleWhile the mathematical example is clever, consider adding a parallel code example to demonstrate the same concept in practice. For example:
// Before refactoring const calculateTotal = (price, quantity, taxRate, discountRate) => { return price * quantity * (1 + taxRate) * (1 - discountRate); }; // After refactoring const calculateSubtotal = (price, quantity) => price * quantity; const applyTax = (amount, taxRate) => amount * (1 + taxRate); const applyDiscount = (amount, discountRate) => amount * (1 - discountRate); const calculateTotal = (price, quantity, taxRate, discountRate) => { const subtotal = calculateSubtotal(price, quantity); const withTax = applyTax(subtotal, taxRate); return applyDiscount(withTax, discountRate); };apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/website.mdx (3)
9-14: Fix grammar and improve clarity
- Fix typo in "good before the attend":
-The [website](https://cuhacking.com) is where hackers get their first impression of cuHacking. From here people will be able to decide if the event is good *before* the attend the event. +The [website](https://cuhacking.com) is where hackers get their first impression of cuHacking. From here people will be able to decide if the event is good *before* they attend the event.
- Consider adding a brief overview of what cuHacking is for new readers.
19-20: Fix grammar in navigation bar descriptionFix the verb agreement:
-The bar at the top of the website should contains links to most of the sections of the site +The bar at the top of the website should contain links to most of the sections of the site🧰 Tools
🪛 LanguageTool
[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)
74-76: Fix grammar and add process details
- Fix grammar in the first sentence:
-Aspiring hackers will have create an account +Aspiring hackers will have to create an account
- Consider adding:
- Expected timeframes for the application process
- Any specific requirements for applicants
- What happens after submission
🧰 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/content/docs/contribution-guidelines/pull-requests.mdx (2)
3-3: Consider revising the description to be more professional.The current description "The diplomatic way to sneak your changes into main. WIP." could be more professional and informative.
-description: The diplomatic way to sneak your changes into main. WIP. +description: A comprehensive guide to submitting and managing pull requests effectively.
72-72: Consider adding more specific naming convention guidance.The current line only mentions camelCase for functions, but it would be helpful to add more specific examples or link to a detailed naming convention guide.
- <td>Functions are named appropriately (camelCase)</td> + <td>Functions are named appropriately (camelCase, e.g., calculateTotal, getUserData)</td>apps/docs/content/docs/contribution-guidelines/getting-started.mdx (1)
177-177: Address TODO comment.The TODO comment about linking Google Calendar should be addressed before merging.
Would you like me to help create a new issue to track this task?
apps/docs/content/docs/installation.mdx (2)
245-245: Fix typographical error.There's a double dot in the text which should be replaced with proper ellipsis.
-..or add `-p` to filter specific projects +...or add `-p` to filter specific projects🧰 Tools
🪛 LanguageTool
[typographical] ~245-~245: Two consecutive dots
Context: ...nx run-many -t ``` ..or add-pto filter specific projects ...(DOUBLE_PUNCTUATION)
307-307: Improve grammar in the team description.The sentence structure could be improved for better readability.
-Connect on our channels and with the cuHacking team to ask questions, get help and keep up to date with the latest events. +Connect on our channels and with the cuHacking team to ask questions, get help, and stay up to date with the latest events.🧰 Tools
🪛 LanguageTool
[grammar] ~307-~307: The word ‘help’ is a conjunction. In formal texts, use “to”.
Context: ...Hacking team to ask questions, get help and keep up to date with the latest events....(HELP_AND_VB)
apps/docs/content/docs/index.mdx (4)
21-25: Consider rephrasing for clarity and conciseness.The welcome message could be more concise. Consider revising line 25 to:
-It's also written in a beginner-friendly language in order to provide a smooth onboarding experience for external contributors, and act as a general open-source reference for other projects. +It's written in beginner-friendly language to provide a smooth onboarding experience for external contributors and serve as an open-source reference.🧰 Tools
🪛 LanguageTool
[style] ~25-~25: Consider a shorter alternative to avoid wordiness.
Context: ...written in a beginner-friendly language in order to provide a smooth onboarding experience ...(IN_ORDER_TO_PREMIUM)
88-88: Simplify language for clarity.-Priority is provided to undergraduate students at [Carleton University](https://carleton.ca/). +Priority is given to undergraduates at [Carleton University](https://carleton.ca/).🧰 Tools
🪛 LanguageTool
[style] ~88-~88: This phrase is redundant. Consider writing “undergraduates”.
Context: ...al institution. Priority is provided to undergraduate students at [Carleton University](https://carlet...(UNDERGRADUATE_STUDENT)
308-313: Consider moving TODOs to GitHub issues.The TODOs listed here should be tracked in GitHub issues for better visibility and tracking. This would also help potential contributors find tasks to work on.
Would you like me to help create GitHub issues for these TODOs?
136-140: Consider using more reliable image hosting.The profile pictures are currently hosted on personal Google Photos links which might expire. Consider:
- Moving images to a project-controlled storage solution
- Using GitHub avatars where possible
- Using a CDN for consistent availability
Also applies to: 156-161, 174-178, 192-196, 211-215, 240-244, 257-261, 275-279
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/design/index.mdx (2)
44-44: Use formal language in documentation.-If you wanna learn more check out our <Link href={DESIGN_GUIDE}>design guide</Link> +For more information, please refer to our <Link href={DESIGN_GUIDE}>design guide</Link>🧰 Tools
🪛 LanguageTool
[style] ~44-~44: The word ‘wanna’ is informal.
Context: ... and a faster production cycle. If you wanna learn more check out our <Link href={DE...(WANNA)
65-66: Consider protecting email addresses.Instead of exposing email addresses directly, consider:
- Using a contact form
- Using a team email alias
- Implementing email address obfuscation
🧰 Tools
🪛 LanguageTool
[style] ~66-~66: In some texts, you can shorten this phrase. Consider using “email me”.
Context: ...? Contact Omar Garcia on slack or send me an email.(SEND_PRP_AN_EMAIL)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
⛔ Files ignored due to path filters (54)
apps/docs-old/public/cuhacking-2020-images/cuplatform-diagram.pngis excluded by!**/*.pngapps/docs-old/public/cuhacking-2020-images/google-docs-applying-formats.pngis excluded by!**/*.pngapps/docs-old/public/cuhacking-2020-images/google-docs-assigning-tasks.pngis excluded by!**/*.pngapps/docs-old/public/cuhacking-2020-images/google-docs-comments.pngis excluded by!**/*.pngapps/docs-old/public/cuhacking-2020-images/google-docs-insert-table-of-contents.pngis excluded by!**/*.pngapps/docs-old/public/cuhacking-2020-images/google-docs-outline.pngis excluded by!**/*.pngapps/docs-old/public/cuhacking-2020-images/google-sheets-decimal-places.pngis excluded by!**/*.pngapps/docs-old/public/cuhacking-2020-images/mobile-app-calendar-layout.pngis excluded by!**/*.pngapps/docs-old/public/cuhacking-2020-images/mobile-app-schedule-layout.pngis excluded by!**/*.pngapps/docs-old/public/cuhacking-2020-images/optional-fees.pngis excluded by!**/*.pngapps/docs-old/public/cuhacking-2020-images/roadmap-labels.pngis excluded by!**/*.pngapps/docs-old/public/cuhacking-2020-images/slack-call-button.pngis excluded by!**/*.pngapps/docs-old/public/cuhacking-2020-images/slack-channel-link.pngis excluded by!**/*.pngapps/docs-old/public/cuhacking-2020-images/slack-channel-mention.pngis excluded by!**/*.pngapps/docs-old/public/cuhacking-2020-images/slack-context-menu.pngis excluded by!**/*.pngapps/docs-old/public/cuhacking-2020-images/slack-custom-theme.pngis excluded by!**/*.pngapps/docs-old/public/cuhacking-2020-images/slack-everyone.pngis excluded by!**/*.pngapps/docs-old/public/cuhacking-2020-images/slack-here.pngis excluded by!**/*.pngapps/docs-old/public/cuhacking-2020-images/slack-name.pngis excluded by!**/*.pngapps/docs-old/public/cuhacking-2020-images/slack-preferences-button.pngis excluded by!**/*.pngapps/docs-old/public/cuhacking-2020-images/slack-preview.pngis excluded by!**/*.pngapps/docs-old/public/cuhacking-2020-images/slack-search.pngis excluded by!**/*.pngapps/docs-old/public/cuhacking-2020-images/slack-sidebar-button.pngis excluded by!**/*.pngapps/docs-old/public/cuhacking-2020-images/slack-workspace-button.pngis excluded by!**/*.pngapps/docs-old/public/cuhacking-2020-images/trello-blocked.JPGis excluded by!**/*.jpgapps/docs-old/public/cuhacking-2020-images/trello-cards.JPGis excluded by!**/*.jpgapps/docs-old/public/cuhacking-2020-images/trello-checklists.JPGis excluded by!**/*.jpgapps/docs-old/public/cuhacking-2020-images/trello-comments.JPGis excluded by!**/*.jpgapps/docs-old/public/cuhacking-2020-images/trello-done.JPGis excluded by!**/*.jpgapps/docs-old/public/cuhacking-2020-images/trello-in-progress.JPGis excluded by!**/*.jpgapps/docs-old/public/cuhacking-2020-images/trello-labels.JPGis excluded by!**/*.jpgapps/docs-old/public/cuhacking-2020-images/trello-linking-google-drive-files-1.JPGis excluded by!**/*.jpgapps/docs-old/public/cuhacking-2020-images/trello-linking-google-drive-files-2.JPGis excluded by!**/*.jpgapps/docs-old/public/cuhacking-2020-images/trello-preview.JPGis excluded by!**/*.jpgapps/docs-old/public/cuhacking-2020-images/trello-ready.JPGis excluded by!**/*.jpgapps/docs-old/public/cuhacking-2020-images/trello-todo.JPGis excluded by!**/*.jpgapps/docs-old/public/cuhacking-2020-images/wiki-repo-page.pngis excluded by!**/*.pngapps/docs-old/public/cuhacking-2020-images/wiki-upload-page.pngis excluded by!**/*.pngapps/docs-old/public/cuhacking-2020-images/zoho-adding-a-signature-important.JPGis excluded by!**/*.jpgapps/docs-old/public/cuhacking-2020-images/zoho-adding-a-signature.JPGis excluded by!**/*.jpgapps/docs-old/public/cuhacking-2020-images/zoho-assigning-emails-tag.JPGis excluded by!**/*.jpgapps/docs-old/public/cuhacking-2020-images/zoho-assigning-emails.JPGis excluded by!**/*.jpgapps/docs-old/public/cuhacking-2020-images/zoho-logging-in.JPGis excluded by!**/*.jpgapps/docs-old/public/cuhacking-2020-images/zoho-signatures-example.JPGis excluded by!**/*.jpgapps/docs-old/public/cuhacking-2020-images/zoho-signatures.JPGis excluded by!**/*.jpgapps/docs-old/public/cuhacking-logo.svgis excluded by!**/*.svgapps/docs-old/public/favicon.icois excluded by!**/*.icoapps/docs-old/src/app/(docs)/favicon.icois excluded by!**/*.icoapps/docs-old/src/content/docs/knowledge-base/hack-the-tunnels-2024/fastfetch-arch-linux.pngis excluded by!**/*.pngapps/docs/content/docs/knowledge-base/hack-the-tunnels-2024/fastfetch-arch-linux.pngis excluded by!**/*.pngapps/docs/public/cuhacking_logo_gradient.svgis excluded by!**/*.svgapps/docs/public/favicon.icois excluded by!**/*.icolibs/external/aceternity/public/cuhacking-logo.svgis excluded by!**/*.svgpnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (82)
.github/workflows/BUILD.yml(2 hunks).github/workflows/TEST_E2E.yml(2 hunks).gitignore(1 hunks)apps/docs-e2e/project.json(0 hunks)apps/docs-e2e/src/docs.spec.ts(3 hunks)apps/docs-e2e/src/example.spec.ts(1 hunks)apps/docs-e2e/src/pom.ts(1 hunks)apps/docs-old/postcss.config.cjs(1 hunks)apps/docs-old/project.json(1 hunks)apps/docs-old/specs/index.spec.tsx(1 hunks)apps/docs-old/tailwind.config.js(1 hunks)apps/docs-old/tsconfig.json(1 hunks)apps/docs/.gitignore(1 hunks)apps/docs/app/(docs)/[[...slug]]/page.tsx(1 hunks)apps/docs/app/(docs)/layout.tsx(1 hunks)apps/docs/app/api/search/route.ts(1 hunks)apps/docs/app/home/layout.tsx(1 hunks)apps/docs/app/home/page.tsx(1 hunks)apps/docs/app/layout.config.tsx(1 hunks)apps/docs/app/layout.tsx(1 hunks)apps/docs/content/docs/common-issues.mdx(1 hunks)apps/docs/content/docs/concepts/clean-code.mdx(1 hunks)apps/docs/content/docs/concepts/conventional-branch.mdx(1 hunks)apps/docs/content/docs/concepts/conventional-comments.mdx(1 hunks)apps/docs/content/docs/concepts/conventional-commits.mdx(1 hunks)apps/docs/content/docs/concepts/design-systems.mdx(1 hunks)apps/docs/content/docs/concepts/diataxis-model.mdx(1 hunks)apps/docs/content/docs/concepts/meta.json(1 hunks)apps/docs/content/docs/concepts/monorepo-architecture.mdx(1 hunks)apps/docs/content/docs/concepts/trunk-based-development.mdx(1 hunks)apps/docs/content/docs/contribution-guidelines/authoring-documentation.mdx(1 hunks)apps/docs/content/docs/contribution-guidelines/code-review.mdx(1 hunks)apps/docs/content/docs/contribution-guidelines/coding-standards/back-end.mdx(1 hunks)apps/docs/content/docs/contribution-guidelines/coding-standards/end-to-end-testing.mdx(1 hunks)apps/docs/content/docs/contribution-guidelines/coding-standards/front-end.mdx(1 hunks)apps/docs/content/docs/contribution-guidelines/coding-standards/index.mdx(1 hunks)apps/docs/content/docs/contribution-guidelines/coding-standards/meta.json(1 hunks)apps/docs/content/docs/contribution-guidelines/coding-standards/tooling.mdx(1 hunks)apps/docs/content/docs/contribution-guidelines/coding-standards/unit-testing.mdx(1 hunks)apps/docs/content/docs/contribution-guidelines/getting-started.mdx(1 hunks)apps/docs/content/docs/contribution-guidelines/meta.json(1 hunks)apps/docs/content/docs/contribution-guidelines/pull-requests.mdx(1 hunks)apps/docs/content/docs/features.mdx(1 hunks)apps/docs/content/docs/glossary.mdx(1 hunks)apps/docs/content/docs/index.mdx(1 hunks)apps/docs/content/docs/installation.mdx(1 hunks)apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/co-leads/index.mdx(1 hunks)apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/co-leads/transitions.mdx(1 hunks)apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/constants.ts(1 hunks)apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/design/design-guide.mdx(1 hunks)apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/design/index.mdx(1 hunks)apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/admin-console.mdx(1 hunks)apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/application-server.mdx(1 hunks)apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/coding-guidelines.mdx(1 hunks)apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/dashboard.mdx(1 hunks)apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/development-timeline.mdx(1 hunks)apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/index.mdx(1 hunks)apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/map-software.mdx(1 hunks)apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/meta.json(1 hunks)apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/mobile-app.mdx(1 hunks)apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/particles.mdx(1 hunks)apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/postman.mdx(1 hunks)apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/website.mdx(1 hunks)apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/getting-started/cusa-funding-non-tuition-fees.mdx(1 hunks)apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/getting-started/how-to-google-docs.mdx(1 hunks)apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/getting-started/how-to-google-sheets.mdx(1 hunks)apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/getting-started/how-to-slack.mdx(1 hunks)apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/getting-started/how-to-trello.mdx(1 hunks)apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/getting-started/how-to-wiki.mdx(1 hunks)apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/getting-started/how-to-zoho.mdx(1 hunks)apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/getting-started/index.mdx(1 hunks)apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/getting-started/leadership-team-management.mdx(1 hunks)apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/getting-started/meta.json(1 hunks)apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/hacker-experience/index.mdx(1 hunks)apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/index.mdx(1 hunks)apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/logistics/index.mdx(1 hunks)apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/marketing/hacker-faqs.mdx(1 hunks)apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/marketing/index.mdx(1 hunks)apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/meta.json(1 hunks)apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/operations/email-template-inviting-a-professor-to-judge.mdx(1 hunks)apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/operations/email-template-soliciting-a-high-school-for-judges.mdx(1 hunks)apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/operations/index.mdx(1 hunks)
⛔ Files not processed due to max files limit (47)
- apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/roadmap/index.mdx
- apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/sponsorship/index.mdx
- apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/sponsorship/signatures.mdx
- apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/sponsorship/sponsorship-faqs.mdx
- apps/docs/content/docs/knowledge-base/hack-the-tunnels-2024/meta.json
- apps/docs/content/docs/knowledge-base/hack-the-tunnels-2024/part-1.mdx
- apps/docs/content/docs/knowledge-base/hack-the-tunnels-2024/part-2.mdx
- apps/docs/content/docs/knowledge-base/hack-the-tunnels-2024/part-3.mdx
- apps/docs/content/docs/knowledge-base/hack-the-tunnels-2024/setup.mdx
- apps/docs/content/docs/knowledge-base/hack-the-tunnels-2024/welcome.mdx
- apps/docs/content/docs/knowledge-base/index.mdx
- apps/docs/content/docs/knowledge-base/meta.json
- apps/docs/content/docs/knowledge-base/nextauth.mdx
- apps/docs/content/docs/meta.json
- apps/docs/content/docs/projects.mdx
- apps/docs/content/docs/tech-stack.mdx
- apps/docs/next-env.d.ts
- apps/docs/next.config.mjs
- apps/docs/postcss.config.cjs
- apps/docs/source.config.ts
- apps/docs/source.ts
- apps/docs/tailwind.config.js
- apps/docs/tsconfig.json
- chromatic.config.json
- libs/docs/components/ui/feature-section.tsx
- libs/docs/global.css
- libs/docs/index.ts
- libs/docs/project.json
- libs/docs/tsconfig.json
- libs/docs/tsconfig.lib.json
- libs/external/aceternity/README.md
- libs/external/aceternity/components/ui/feature-section.tsx
- libs/external/aceternity/eslint.config.js
- libs/external/aceternity/global.css
- libs/external/aceternity/index.ts
- libs/external/aceternity/lib/utils/cn.ts
- libs/external/aceternity/lib/utils/index.ts
- libs/external/aceternity/postcss.config.js
- libs/external/aceternity/project.json
- libs/external/aceternity/tailwind.config.ts
- libs/external/aceternity/tsconfig.json
- libs/external/aceternity/tsconfig.lib.json
- libs/shared/config/eslint/default.js
- libs/shared/config/tailwind/shadcn.ts
- nx.json
- package.json
- tsconfig.base.json
💤 Files with no reviewable changes (1)
- apps/docs-e2e/project.json
✅ Files skipped from review due to trivial changes (26)
- apps/docs/content/docs/contribution-guidelines/coding-standards/meta.json
- apps/docs/app/api/search/route.ts
- apps/docs/content/docs/concepts/conventional-comments.mdx
- apps/docs/content/docs/contribution-guidelines/coding-standards/unit-testing.mdx
- apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/marketing/index.mdx
- apps/docs/content/docs/concepts/meta.json
- apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/logistics/index.mdx
- apps/docs/content/docs/common-issues.mdx
- apps/docs/content/docs/contribution-guidelines/coding-standards/tooling.mdx
- apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/operations/index.mdx
- apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/co-leads/index.mdx
- apps/docs-old/tsconfig.json
- apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/meta.json
- apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/getting-started/meta.json
- apps/docs/.gitignore
- apps/docs/content/docs/concepts/diataxis-model.mdx
- apps/docs/content/docs/contribution-guidelines/meta.json
- apps/docs-old/project.json
- apps/docs/content/docs/contribution-guidelines/code-review.mdx
- apps/docs/content/docs/contribution-guidelines/coding-standards/back-end.mdx
- apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/hacker-experience/index.mdx
- apps/docs/content/docs/concepts/design-systems.mdx
- apps/docs/content/docs/contribution-guidelines/coding-standards/front-end.mdx
- apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/meta.json
- apps/docs/content/docs/features.mdx
- apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/getting-started/index.mdx
🧰 Additional context used
🪛 LanguageTool
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/getting-started/how-to-google-docs.mdx
[uncategorized] ~5-~5: The preposition “of” seems more likely in this position.
Context: ...w to: Google Docs" --- _Brief overview into how to best use Google Docs + some tips...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
[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)
[uncategorized] ~23-~23: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...ears on the left-hand-side with all the heading and subheadings. <img width="421" ...
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[grammar] ~41-~41: Do not use the modal verb ‘will’ after the verb ‘be’.
Context: ..., the paragraph / text where the cursor is will convert to this format. ## Shortcuts ...
(BE_MD)
[uncategorized] ~57-~57: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ented text will be highlighted in yellow and you can add a comment in the dialog box...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~61-~61: Possible missing comma found.
Context: ... want to assign a task to someone using comments you can write their email preceded by @...
(AI_HYDRA_LEO_MISSING_COMMA)
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/getting-started/cusa-funding-non-tuition-fees.mdx
[grammar] ~5-~5: The word “opt-out” is a noun. The verb is spelled with a space.
Context: ...’s Student Choice Initiative we can now opt-out of certain student fees, but this can a...
(NOUN_VERB_CONFUSION)
[style] ~11-~11: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...owed to opt out of non-tuition fees, we are able to opt-out of funding CUSA Clubs and Socie...
(BE_ABLE_TO)
[grammar] ~11-~11: The word “opt-out” is a noun. The verb is spelled with a space.
Context: ...out of non-tuition fees, we are able to opt-out of funding CUSA Clubs and Societies. I...
(NOUN_VERB_CONFUSION)
[style] ~12-~12: Consider a shorter alternative to avoid wordiness.
Context: ...t of funding CUSA Clubs and Societies. In order to ensure that their funding does not drop...
(IN_ORDER_TO_PREMIUM)
[grammar] ~13-~13: The word “opt-out” is a noun. The verb is spelled with a space.
Context: ...at clubs that apply for funding, do not opt-out of CUSA’s Clubs and Societies fee: - _...
(NOUN_VERB_CONFUSION)
[grammar] ~24-~24: The word “opt-out” is a noun. The verb is spelled with a space.
Context: ...semesters select which fees you want to opt-out of. Make sure the checkbox beside the ...
(NOUN_VERB_CONFUSION)
[style] ~36-~36: Consider a shorter alternative to avoid wordiness.
Context: ...in** for CUSA’s Clubs and Societies fee in order to receive any funding from CUSA that seme...
(IN_ORDER_TO_PREMIUM)
apps/docs/content/docs/contribution-guidelines/authoring-documentation.mdx
[style] ~34-~34: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...instead of using English connectives. - Use Tables to express different things ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/index.mdx
[uncategorized] ~13-~13: You might be missing the article “the” here.
Context: ...tps://cuhacking.com), however this year dev-team is creating a suite of services to...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[style] ~32-~32: The phrase “a variety of” may be wordy. To make your writing clearer, consider replacing it.
Context: ...form-diagram.png) ## Tools We also use a variety of tools to help us get our job done. - <...
(A_VARIETY_OF)
[duplication] ~45-~45: Possible typo: you repeated a word
Context: ...w/edit?usp=sharing). ## Our Members Wal Wal - Team L...
(ENGLISH_WORD_REPEAT_RULE)
apps/docs/content/docs/contribution-guidelines/coding-standards/end-to-end-testing.mdx
[style] ~84-~84: Consider shortening or rephrasing this to strengthen your wording.
Context: ...egardless of whether you push code that makes changes to these E2E tests.
(MAKE_CHANGES)
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/getting-started/how-to-zoho.mdx
[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/content/docs/knowledge-base/cuHacking-2020-wiki/getting-started/how-to-slack.mdx
[grammar] ~11-~11: Did you mean the communication tool “Slack” (= proper noun, capitalized)?
Context: ...eywords You can use some keywords in a slack message either to get people’s attentio...
(ON_SKYPE)
[grammar] ~45-~45: Did you mean the communication tool “Slack” (= proper noun, capitalized)?
Context: ...re two ways of editing messages sent on slack. ### Up-arrow You can edit the last m...
(ON_SKYPE)
[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)
[uncategorized] ~88-~88: Possible missing comma found.
Context: ...of the line. - This is a list item - This an indented list item This is how you ...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~109-~109: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...te to a channel or DM or to use Slack’s very powerful search feature. 
[grammar] ~115-~115: “Google” is a proper noun and needs to be capitalized.
Context: ...ing Google Drive You can link your own google account to the slack workspace in order...
(A_GOOGLE)
[style] ~122-~122: Consider a shorter alternative to avoid wordiness.
Context: ...blebot to create and share doodle polls in order to find time slots that work for most peop...
(IN_ORDER_TO_PREMIUM)
[style] ~126-~126: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...Polls You can create a poll for voting very easily. They're created with the /poll comma...
(EN_WEAK_ADJECTIVE)
[uncategorized] ~136-~136: Consider adding a hyphen.
Context: ...: 1. Press the workspace button in the top left corner and go to Preferences (or Pres...
(TOP_LEFT_CORNER)
[grammar] ~151-~151: Did you mean “Copy and paste”?
Context: ...e themes that match our colour schemes. Copy paste either of these into the text box to us...
(COPY_PASTE)
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/postman.mdx
[uncategorized] ~17-~17: When ‘Postman-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...de-js-6c7428d3da02) Before we get into Postman specific things, there are some steps any good t...
(SPECIFIC_HYPHEN)
[style] ~30-~30: Consider a shorter alternative to avoid wordiness.
Context: ...Section WIP.* ## Running Postman Tests In order to run tests made in Postman, you'll need ...
(IN_ORDER_TO_PREMIUM)
[style] ~33-~33: Consider a shorter alternative to avoid wordiness.
Context: ...ion. Postman tests come as JSON files. In order to run them, you just need to open up Post...
(IN_ORDER_TO_PREMIUM)
[style] ~33-~33: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...N files. In order to run them, you just need to open up Postman, and import them wi...
(REP_NEED_TO_VB)
[uncategorized] ~33-~33: Consider adding a hyphen.
Context: ...collection, you can hit the gear in the top right corner and press "Import" to import tha...
(TOP_LEFT_CORNER)
[style] ~35-~35: In contexts where ‘if’ is followed by ‘or’, using ‘whether’ may be more appropriate (and formal).
Context: ... is great if your goal is just to check if whatever you're testing works or not. T...
(IF_WHETHER)
[style] ~37-~37: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ve more control over which requests you want to run. (For example, you might want to sk...
(REP_WANT_TO_VB)
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/getting-started/how-to-trello.mdx
[uncategorized] ~8-~8: Possible missing comma found.
Context: ...nd your team._ ## Why use Trello? This year we want to use trello to help us track ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~8-~8: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...large event. We have about 30 organizers and we need some system to track who is ass...
(COMMA_COMPOUND_SENTENCE)
[grammar] ~33-~33: It appears that a hyphen is missing in the noun “to-do” (= task) or did you mean the verb “to do”?
Context: ...hould be left –> right. Ideally: todo –> ready –> in progress –> done **Unid...
(TO_DO_HYPHEN)
[grammar] ~35-~35: It appears that a hyphen is missing in the noun “to-do” (= task) or did you mean the verb “to do”?
Context: ...dy –> in progress –> done Unideal: todo –> ready –> in progress –> blocked –> i...
(TO_DO_HYPHEN)
[grammar] ~37-~37: It appears that a hyphen is missing in the noun “to-do” (= task) or did you mean the verb “to do”?
Context: ... –> blocked –> in progress –> done ### todo 
[grammar] ~47-~47: Did you mean “Google Drive”?
Context: ...st, maybe a deadline, links to files on google drive, and then add it to the ready list....
(GOOGLE_PRODUCTS)
[typographical] ~47-~47: It appears that a comma is missing.
Context: ...n add it to the ready list. At this point a task should be clearly defined and s...
(DURING_THAT_TIME_COMMA)
[uncategorized] ~47-~47: “to the” seems less likely than “to”.
Context: ...be clearly defined and should be ready to the either the progress list or blocked lis...
(AI_HYDRA_LEO_CP_TO_THE_TO)
[style] ~73-~73: This phrase is redundant. Consider writing “sure”.
Context: ...list. Only move cards here once you are absolutely sure that every step of a task has been comp...
(ABSOLUTELY_SURE)
[misspelling] ~79-~79: This expression is normally spelled as one or with a hyphen.
Context: ...ght make more sense to have two smaller sub tasks cards rather than one._ Each task shou...
(EN_COMPOUNDS_SUB_TASKS)
[style] ~85-~85: To elevate your writing, try using more descriptive phrasing here.
Context: ... of the task – the owner. One of the biggest challenges to using trello, is knowing ...
(BIGGEST_CHALLENGE)
[uncategorized] ~91-~91: A comma may be missing after the conjunctive/linking adverb ‘Therefore’.
Context: ...s by adding a description to each card. Therefore a description is required for each card...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[uncategorized] ~97-~97: Possible missing comma found.
Context: ...– how to complete the task? As well as these the card should contain any other infor...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~97-~97: Did you mean “Google Drive”?
Context: ... that relate to this task. You can link google drive files, websites, or add ideas in the de...
(GOOGLE_PRODUCTS)
[grammar] ~100-~100: Did you mean the formatting language “Markdown” (= proper noun)?
Context: ...cription. ### Markdown Trello supports markdown syntax, which allows you to create head...
(MARKDOWN_NNP)
[duplication] ~124-~124: Possible typo: you repeated a word
Context: ...lp/) find out more Markdown tricks! ## Checklists Checklists are one of my favourite features of tre...
(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~134-~134: Possible missing comma found.
Context: ...what labels work best for them. On the right you can see some example labels. ![imag...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~140-~140: If this is a question, use a question mark.
Context: ... well as putting it in the done list. This a good way to confirm if a task is...
(QUESTION_MARK)
[grammar] ~140-~140: A verb may be missing.
Context: ...ell as putting it in the done list. This a good way to confirm if a task is done...
(THIS_MISSING_VERB)
[uncategorized] ~146-~146: Possible missing comma found.
Context: ...card has an Activity section at the bottom sorted top-to-bottom by most recent fir...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~148-~148: Did you mean the proper noun or did you want to use it as a verb?
Context: ...stions_ – though, it is often easier to use slack for longer conversations._ Comments ar...
(HAVE_TWITTER)
[grammar] ~150-~150: Did you mean “Google Drive”?
Context: ...hat doesn’t need a full document on the google drive _– especially since you can edit commen...
(GOOGLE_PRODUCTS)
[grammar] ~153-~153: Did you mean “Google Drive”?
Context: ...ng Google Drive Files You can link your google drive to trello which allows you to browse an...
(GOOGLE_PRODUCTS)
[uncategorized] ~153-~153: Possible missing comma found.
Context: ...Files You can link your google drive to trello which allows you to browse and add goog...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~153-~153: Did you mean “Google Drive”?
Context: ...ello which allows you to browse and add google drive files to a card, using what trello call...
(GOOGLE_PRODUCTS)
[grammar] ~162-~162: Did you mean “Google Drive”?
Context: ...) _For more information on how to link google drive to trello, see this [website](https://h...
(GOOGLE_PRODUCTS)
[grammar] ~165-~165: Did you mean “Google Drive”?
Context: ...a Power-Up, in much the same way as the google drive Power-Up. For more information see this...
(GOOGLE_PRODUCTS)
[grammar] ~171-~171: Did you mean the communication tool “Slack” (= proper noun, capitalized)?
Context: ...trello, you should also message them on slack so they are aware of their task. Do not...
(ON_SKYPE)
[misspelling] ~173-~173: Did you mean “there”?
Context: ...a task. Make sure they understand what their are supposed to do and how to do it; pr...
(THEIR_IS)
[style] ~173-~173: Consider using a more formal alternative.
Context: ...upposed to do and how to do it; provide more information if needed. If they are unable to comple...
(MORE_INFO)
[grammar] ~183-~183: Before the countable noun ‘for’ an article or a possessive pronoun is necessary.
Context: ...asks d Add deadlines / due-dates for card while hovering your mouse over it. a...
(IN_NN_CC_VBG)
[uncategorized] ~199-~199: Possible missing preposition found.
Context: ...ll the shortcuts in case you forgot how trigger one. ### More keyboard shortcuts If yo...
(AI_HYDRA_LEO_MISSING_TO)
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/getting-started/how-to-wiki.mdx
[uncategorized] ~31-~31: Possible missing comma found.
Context: ...g-wiki/tree/master/resources) - On this page you'll see a button labeled `Upload fil...
(AI_HYDRA_LEO_MISSING_COMMA)
[duplication] ~39-~39: Possible typo: you repeated a word
Context: ...oad-page.png) - Label your commit with the the format `Upload file1.png, file2.png, fi...
(ENGLISH_WORD_REPEAT_RULE)
[style] ~68-~68: As an alternative to the over-used intensifier ‘really’, consider replacing this phrase.
Context: ...e by everyone # Gotchas - Links break really easily with GitHub wiki. Don't change a page n...
(EN_WEAK_ADJECTIVE)
[grammar] ~70-~70: “Google” is a proper noun and needs to be capitalized.
Context: ...ple need to collaborate on, put it in a google doc and link to it from the wiki - Don'...
(A_GOOGLE)
[uncategorized] ~71-~71: Possible missing comma found.
Context: ... from a page in the sidebar. There's no sitemap so it becomes difficult to go back and ...
(AI_HYDRA_LEO_MISSING_COMMA)
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/getting-started/leadership-team-management.mdx
[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)
[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 @channel on 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 @name in 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/content/docs/contribution-guidelines/coding-standards/index.mdx
[uncategorized] ~22-~22: Possible missing comma found.
Context: ...e will be read more than it is written. Thankfully you don't have to memorize all of the c...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~22-~22: Consider removing “of” to be more concise
Context: .... Thankfully you don't have to memorize all of the conventions, as most of them have been ...
(ALL_OF_THE)
apps/docs/content/docs/concepts/clean-code.mdx
[grammar] ~42-~42: It appears that a hyphen is missing in the plural noun “to-dos”?
Context: ...ains products like IntelliJ IDEA handle TODOs and other code annotations. - [**FixmeC...
(TO_DO_HYPHEN)
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/coding-guidelines.mdx
[uncategorized] ~5-~5: A comma may be missing after the conjunctive/linking adverb ‘However’.
Context: ...nes --- At dev-team, we program a lot. However everyone has different programming back...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[grammar] ~29-~29: If the situation that you’re describing is mandatory or essential, you can use the subjunctive mood here.
Context: ...our code. It is essential that everyone is clear on how we use git so that our com...
(SUBJUNCTIVE_MOOD)
[duplication] ~32-~32: Possible typo: you repeated a word
Context: ... to git. - Connecting your terminal to git - [Git command cheat sheet](https://education....
(ENGLISH_WORD_REPEAT_RULE)
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/admin-console.mdx
[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)
[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)
[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/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/mobile-app.mdx
[style] ~17-~17: ‘Prior to’ might be wordy. Consider a shorter alternative.
Context: ...tc.) in an easily accessible location. Prior to the hackathon beginning, this screen wo...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
[uncategorized] ~24-~24: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...s on an announcement, it will open up a full screen details page showing a full description...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~31-~31: This phrase is redundant. Consider using “outside”.
Context: ... have data). Since “joining” a network outside of the network’s range will simply save th...
(OUTSIDE_OF)
[style] ~31-~31: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...will simply save the network for later, prior to the event this button will say “Save Ne...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
[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)
[uncategorized] ~57-~57: A comma might be missing here.
Context: ...t, as it's the easiest. If we have more time we can explore the others. ### Event D...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~63-~63: This verb may not be in the correct form. Consider using a different form for this context.
Context: ...he system’s alarm scheduler rather than use push notifications. #### Development N...
(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)
[uncategorized] ~66-~66: The preposition “at” seems more likely in this position than the preposition “in”.
Context: ...pment Note The reminder might just come in a fixed time, for the sake of less taps...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION_IN_AT)
[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)
[uncategorized] ~75-~75: The preposition “on” seems more likely in this position than the preposition “in”.
Context: ...ve to name this building Richcraft Hall in the map. Hacker rooms will be indicate...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION_IN_ON)
[uncategorized] ~88-~88: The preposition “on” seems more likely in this position than the preposition “in”.
Context: ...it will be provided as a dedicated icon in the top right hand side of the screen a...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION_IN_ON)
[uncategorized] ~88-~88: Did you mean the adjective “right-hand”?
Context: ...provided as a dedicated icon in the top right hand side of the screen as part of the app’s...
(MISSING_HYPHEN)
[style] ~90-~90: Consider removing “of” to be more concise
Context: ...in to their cuHacking account to unlock all of the app’s features. (such as food alerts, a...
(ALL_OF_THE)
[grammar] ~93-~93: The word “popup” is a noun. The verb is spelled with a space.
Context: ...r fullscreen, depending on design) will popup asking them to sign in. The sign in scr...
(NOUN_VERB_CONFUSION)
[uncategorized] ~93-~93: A comma might be missing here.
Context: ...n in. The sign in screen will be pretty simple simply featuring a username and passwor...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[typographical] ~93-~93: Two consecutive dots
Context: ...d also be provided for walk-in attendees.. Note: Single-use login emails for walk-...
(DOUBLE_PUNCTUATION)
[uncategorized] ~95-~95: A comma might be missing here.
Context: ...atform’s autocomplete or authentication systems which will make the sign in process eas...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~95-~95: The noun “sign-in” is spelled with a hyphen.
Context: ...hentication systems which will make the sign in process easier. One idea was to offer ...
(SIGN_UP_HYPHEN)
[uncategorized] ~100-~100: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...e user profile menu item will open up a full screen detail page for the user. It will prom...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~102-~102: A comma might be missing here.
Context: ... will prominently feature the user’s QR code which will make it easy for the user to...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[style] ~109-~109: You have already used this phrasing in nearby sentences. Consider using an alternative to add variety to your writing.
Context: ...he app, the user profile screen will be replaced with a QR code scanner for scanning hacker c...
(REP_REPLACEMENT)
[uncategorized] ~113-~113: Possible missing comma found.
Context: ... screen will display a live view of the camera with a highlighted area in the center t...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~120-~120: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...privacy policy, license notices for the open source libraries used in making the app, the a...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~123-~123: Consider a shorter alternative to avoid wordiness.
Context: ...be slightly different for the dark mode in order to maintain appropriate and accessible con...
(IN_ORDER_TO_PREMIUM)
[uncategorized] ~131-~131: Possible missing comma found.
Context: ...sider publishing the app roughly a week beforehand containing only the Information Screen ...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~132-~132: ‘During the course of’ might be wordy. Consider a shorter alternative.
Context: ...back later!” (or something like that). During the course of the week, these features can be enabled...
(EN_WORDINESS_PREMIUM_DURING_THE_COURSE_OF)
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/design/design-guide.mdx
[typographical] ~7-~7: Consider adding a comma here.
Context: ...system For reference to the brand guide please visit link --- ## ∆ The ...
(PLEASE_COMMA)
[uncategorized] ~24-~24: Possible missing comma found.
Context: ...take place during a weekly or bi-weekly basis depending on deadlines. --- ### Draft...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~30-~30: In American English, abbreviations like “etc.” require a period.
Context: ...(To see where things are put in a page, etc). - Keep in mind this stage is very ...
(ETC_PERIOD)
[style] ~37-~37: Try using a synonym here to strengthen your writing.
Context: ...n. This will allow the external team to give feedback on the design without clutteri...
(GIVE_PROVIDE)
[style] ~38-~38: Try using a synonym here to strengthen your writing.
Context: ...d must approve of the current design or give feedback for the second draft stage. Th...
(GIVE_PROVIDE)
[style] ~45-~45: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...p. - This draft should still be kept very simple. --- ### Feedback loop - Round 2 -...
(EN_WEAK_ADJECTIVE)
[style] ~63-~63: In American English, abbreviations like “etc.” require a period.
Context: ... in the required format (PDF, PNG, SVG, etc). --- # The design system Coming soon...
(ETC_PERIOD)
apps/docs/content/docs/installation.mdx
[typographical] ~245-~245: Two consecutive dots
Context: ...nx run-many -t ``` ..or add -p to filter specific projects ...
(DOUBLE_PUNCTUATION)
[grammar] ~307-~307: The word ‘help’ is a conjunction. In formal texts, use “to”.
Context: ...Hacking team to ask questions, get help and keep up to date with the latest events....
(HELP_AND_VB)
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/map-software.mdx
[misspelling] ~5-~5: This word is normally spelled with a hyphen.
Context: ...visual components: the basemap, and our custom building layers. The basemap will be used to dis...
(EN_COMPOUNDS_CUSTOM_BUILDING)
[misspelling] ~5-~5: This word is normally spelled with a hyphen.
Context: ..., and other immediate surroundings. Our custom building layers will show the floor plans of the...
(EN_COMPOUNDS_CUSTOM_BUILDING)
[uncategorized] ~11-~11: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...mapbox.com/) produces various tools and open source libraries for creating and displaying M...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~11-~11: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...playing maps. They also provide similar open source SDKs for [Android](https://docs.mapbox....
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[misspelling] ~31-~31: This word is normally spelled with a hyphen.
Context: ...mes are clean, minimalistic, and really good looking. Our custom layers will be featured on...
(EN_COMPOUNDS_GOOD_LOOKING)
[style] ~74-~74: Consider a shorter alternative to avoid wordiness.
Context: ...popup-on-click/). ### Floor Selection In order to allow users to select which floor they'...
(IN_ORDER_TO_PREMIUM)
[misspelling] ~75-~75: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...or they'd like to view, we will provide a overlaid selection bar on the top right...
(EN_A_VS_AN)
[style] ~77-~77: Consider removing “of” to be more concise
Context: ...th only a FillLayer and LineLayer using all of the polygon data that we have. Currently w...
(ALL_OF_THE)
[uncategorized] ~78-~78: A comma may be missing after the conjunctive/linking adverb ‘Currently’.
Context: ... all of the polygon data that we have. Currently we will only need to handle displaying ...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[style] ~80-~80: This phrase is redundant. Consider writing “At this point”, “At this time”, or “now”.
Context: ...erent floor selection considerations. At this point in time (mid-July) we won't worry about the qua...
(AT_THIS_POINT_IN_TIME)
[style] ~83-~83: The phrase “take into consideration” may be wordy. To make your writing clearer, consider replacing it.
Context: ...ween several of them. Another thing to take into consideration when determining how to load the `.geoj...
(TAKE_INTO_CONSIDERATION)
apps/docs/content/docs/index.mdx
[style] ~25-~25: Consider a shorter alternative to avoid wordiness.
Context: ...written in a beginner-friendly language in order to provide a smooth onboarding experience ...
(IN_ORDER_TO_PREMIUM)
[uncategorized] ~77-~77: Loose punctuation mark.
Context: ...asks.', icon: , }, ].map((feature, index) => ( <Feat...
(UNLIKELY_OPENING_PUNCTUATION)
[style] ~88-~88: This phrase is redundant. Consider writing “undergraduates”.
Context: ...al institution. Priority is provided to undergraduate students at [Carleton University](https://carlet...
(UNDERGRADUATE_STUDENT)
[uncategorized] ~141-~141: Loose punctuation mark.
Context: ...h={24} height={24} /> } /> ## UI/UX Design <Ca...
(UNLIKELY_OPENING_PUNCTUATION)
apps/docs/content/docs/contribution-guidelines/getting-started.mdx
[style] ~55-~55: Consider a shorter alternative to avoid wordiness.
Context: ...ndows/wsl/install) is highly encouraged in order to avoid those rare, maddening, a-tiny-par...
(IN_ORDER_TO_PREMIUM)
[style] ~55-~55: To elevate your writing, try using a synonym here.
Context: ...-library-breaks issues that can be very hard to debug. Ubun...
(HARD_TO)
[duplication] ~148-~148: Possible typo: you repeated a word
Context: ...issue by commenting on it. ## Create a Branch Branch from main with the following name for...
(ENGLISH_WORD_REPEAT_RULE)
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/co-leads/transitions.mdx
[style] ~9-~9: Consider a shorter alternative to avoid wordiness.
Context: ...op ourselves into a better organization in order to better reach our goals and provide a be...
(IN_ORDER_TO_PREMIUM)
[uncategorized] ~15-~15: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...orward. These responses give you a trend but they don’t tend to be very in-depth; th...
(COMMA_COMPOUND_SENTENCE)
[typographical] ~28-~28: It appears that a comma is missing.
Context: ... - Cooperation with other team members 3. **Were you ever expected to complete a task ou...
(COMMA_BEFORE_QUESTION_WITH_MD)
[style] ~32-~32: In American English, abbreviations like “etc.” require a period.
Context: ...s, better communication from directors, etc) 5. **Did a director or team member eve...
(ETC_PERIOD)
[style] ~35-~35: Try using a synonym here to strengthen your wording.
Context: ...e been avoided, how? 6. **Make any open comments about each of the following departments...
(COMMENT_REMARK)
[style] ~36-~36: 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: ...h of the following departments.** - Feel free to touch on any topic, and you're open to ...
(FEEL_FREE_TO_STYLE_ME)
[style] ~36-~36: The phrase ‘talk about’ can be informal. To elevate your writing, consider using a more professional alternative.
Context: ...artment you were not a part of. You can talk about your personal experience, or what you w...
(TALK_ABOUT_DISCUSS)
[style] ~52-~52: Consider a shorter alternative to avoid wordiness.
Context: ...ebriefing Meetings These are important in order to get more in-depth insights about how th...
(IN_ORDER_TO_PREMIUM)
[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)
[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)
[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)
[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)
apps/docs/content/docs/glossary.mdx
[style] ~26-~26: Consider removing “of” to be more concise
Context: ...ectory within a workspace that contains all of the project-specific files. | | ...
(ALL_OF_THE)
[misspelling] ~31-~31: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’.
Context: ... | | Workspace | Area in an Nx project containing apps and libs, co...
(EN_A_VS_AN)
apps/docs/content/docs/concepts/trunk-based-development.mdx
[style] ~16-~16: Consider using an extreme adjective for ‘small’.
Context: ...me reliability. - Our core team size is extremely small (three at time of writing). Bandwidth f...
(EXTREME_ADJECTIVES)
[misspelling] ~16-~16: Did you mean “at a time”, “at the time”, or “at times”?
Context: ...ore team size is extremely small (three at time of writing). Bandwidth for review labor...
(AT_TIME2)
[uncategorized] ~20-~20: A determiner appears to be missing. Consider inserting it.
Context: ... is time spent not shipping features. - Majority of time is generally spent debugging. ...
(AI_EN_LECTOR_MISSING_DETERMINER)
[uncategorized] ~20-~20: You might be missing the article “the” here.
Context: ...nt not shipping features. - Majority of time is generally spent debugging. Therefor...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/index.mdx
[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/content/docs/contribution-guidelines/pull-requests.mdx
[grammar] ~125-~125: This term is normally spelled with a hyphen.
Context: ...# What is a CODEOWNER? Code owners are subject matter experts for specific areas of the codebase. Th...
(SUBJECT_MATTER_HYPHEN)
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/dashboard.mdx
[grammar] ~17-~17: Using ‘couple’ without ‘of’ is considered to be informal.
Context: ...vent The actual Dashboard. Split into a couple sections which can be reached by visiting differ...
(PLENTY_OF_NOUNS)
[grammar] ~24-~24: When ‘logged-in’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...e moved out of view. ### Profile Once logged in users can see their QR Badge, team info...
(LOGGED_IN_HYPHEN)
[uncategorized] ~30-~30: The preposition “about” seems more likely in this position.
Context: ...click on any event to find more details for the event. Logged in (and accepted) use...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
[grammar] ~30-~30: The verb ‘signed into’ is not standard English, except in the context of the law (“The bill was signed into law”). Write “signed in to”. For websites and computers, other options are “logged in to” or “logged on to”.
Context: ...list and receive a push notification if signed into the app. ### Map An interactive map fo...
(SIGN_INTO)
[uncategorized] ~33-~33: A comma might be missing here.
Context: ...cess to. Clicking a room will show more details including all the events scheduled in t...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/website.mdx
[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)
[style] ~44-~44: In some texts, you can shorten this phrase. Consider using “email us”.
Context: ... students at Carleton", and "Questions? Send us an email at [email protected]" will be here too...
(SEND_PRP_AN_EMAIL)
[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/content/docs/concepts/conventional-commits.mdx
[uncategorized] ~24-~24: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ommit messages will become second nature and you'll no longer need to use Commitizen...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~33-~33: Possible missing article found.
Context: ...e commit history clean and concise. - Only exception to this is if the commit alre...
(AI_HYDRA_LEO_MISSING_THE)
[grammar] ~33-~33: The verb ‘amend’ does not usually follow articles like ‘an’. Check that ‘amend’ is spelled correctly; using ‘amend’ as a noun may be non-standard.
Context: ...fixup commit should be made rather than an amend. If that commit is amended and force pu...
(A_INFINITIVE)
[grammar] ~36-~36: The preposition ‘to’ may be missing (allow someone to do something).
Context: ... is well worth the effort. It allows us unlock some pretty powerful DevOps which saves...
(ALLOW_TO_DO)
[uncategorized] ~36-~36: Possible missing comma found.
Context: ...t allows us unlock some pretty powerful DevOps which saves the entire team a lot of ti...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~36-~36: ‘in the long run’ might be wordy. Consider a shorter alternative.
Context: ...ich saves the entire team a lot of time in the long run. ### Decision Tree To ease the proces...
(EN_WORDINESS_PREMIUM_IN_THE_LONG_RUN)
[style] ~109-~109: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... the scope should be docs,web,portal. If you have changes in docs, and web ,...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/design/index.mdx
[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)
[style] ~44-~44: The word ‘wanna’ is informal.
Context: ... and a faster production cycle. If you wanna learn more check out our <Link href={DE...
(WANNA)
[style] ~66-~66: In some texts, you can shorten this phrase. Consider using “email me”.
Context: ...? Contact Omar Garcia on slack or send me an email.
(SEND_PRP_AN_EMAIL)
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/application-server.mdx
[style] ~8-~8: In American English, abbreviations like “etc.” require a period.
Context: ... the back-end (the database, Mailchimp, etc). It provides a cross-platform method ...
(ETC_PERIOD)
[style] ~33-~33: Qualifiers like “somewhat” can weaken your message and make your writing sound uncertain. Consider removing it or choosing an alternative to sound more confident.
Context: ... That's it. The entire file should look somewhat like just the list of endpoints, meanin...
(SOMEWHAT)
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/development-timeline.mdx
[typographical] ~33-~33: Consider putting a comma before the abbreviation “i.e.”.
Context: ...- Full website ready (up at Marketing's discretion i.e. once we have sponsors to show) for **Sn...
(IE_COMMA)
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/particles.mdx
[uncategorized] ~12-~12: It appears that hyphens are missing in the adjective “up-to-date”.
Context: ...ly incompatible is IE 6, 7, 8. For more up to date information on canvas support, [take a ...
(UP_TO_DATE_HYPHEN)
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/getting-started/how-to-google-sheets.mdx
[style] ~9-~9: Consider shortening this phrase to just ‘whether’, unless you mean ‘regardless of whether’.
Context: ...s will bring up a few options including whether or not your table has a header / footer. This ...
(WHETHER)
[uncategorized] ~14-~14: Possible missing comma found.
Context: ... Formatting You can create conditional formatting which allows you to visualize your data...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~35-~35: Possible missing preposition found.
Context: ...it. ## Unique This formula allows you get all unique values from a selection of c...
(AI_HYDRA_LEO_MISSING_TO)
[uncategorized] ~35-~35: Possible missing comma found.
Context: ...want to see what schools people applied from you can use this formula to get a list ...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~39-~39: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ll the unique schools. ## Sort If you want to sort some rows (including the list of u...
(REP_WANT_TO_VB)
[typographical] ~45-~45: After the expression ‘for example’ a comma is usually used.
Context: ... a range matches a criterion cell. For example if you wanted to count the number of ap...
(COMMA_FOR_EXAMPLE)
[grammar] ~51-~51: Possible agreement error. Did you mean “times”?
Context: ...row by a different value, but there are time when you want to compare a value in eve...
(THERE_VBP_NN)
[uncategorized] ~57-~57: Possible missing comma found.
Context: ... up a lot when comparing one value to a range such as using the Countif formula. # F...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~61-~61: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...le if you were looking at applicant data but you only wanted participants’ informati...
(COMMA_COMPOUND_SENTENCE)
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/marketing/hacker-faqs.mdx
[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/content/docs/knowledge-base/cuHacking-2020-wiki/operations/email-template-inviting-a-professor-to-judge.mdx
[style] ~4-~4: 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: ...late Inviting a Professor to Judge --- Please feel free to use the template below when emailing pr...
(FEEL_FREE_TO_STYLE_ME)
[style] ~5-~5: ‘any and all’ might be wordy. Consider a shorter alternative.
Context: ...ntire text and make sure to update/omit any and all 2020 event specific information_; this ...
(EN_WORDINESS_PREMIUM_ANY_AND_ALL)
[uncategorized] ~5-~5: When ‘event-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...ke sure to update/omit any and all 2020 event specific information_; this information has been...
(SPECIFIC_HYPHEN)
[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)
[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/content/docs/knowledge-base/cuHacking-2020-wiki/operations/email-template-soliciting-a-high-school-for-judges.mdx
[style] ~4-~4: 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: ...oliciting a High School for Judges --- Please feel free to use the template below when emailing Hi...
(FEEL_FREE_TO_STYLE_ME)
[style] ~5-~5: ‘any and all’ might be wordy. Consider a shorter alternative.
Context: ...ntire text and make sure to update/omit any and all 2020 event specific information_; this ...
(EN_WORDINESS_PREMIUM_ANY_AND_ALL)
[uncategorized] ~5-~5: When ‘event-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...ke sure to update/omit any and all 2020 event specific information_; this information has been...
(SPECIFIC_HYPHEN)
[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)
🔇 Additional comments (38)
apps/docs-old/postcss.config.cjs (2)
1-2: LGTM! Good practice using node:path for file path handling
The use of node:path for handling file paths is a good practice as it ensures consistent path resolution across different operating systems. The explicit configuration path helps maintain clarity in the build process.
Also applies to: 10-12
8-15: Verify Tailwind configuration existence
Since this configuration explicitly points to a Tailwind config file, we should verify its existence to prevent build failures.
✅ Verification successful
Tailwind configuration is properly set up and valid
The Tailwind configuration file exists at the specified location and contains a valid configuration with:
- Content paths correctly configured for the docs-old app
- Integration with fumadocs-ui preset
- Proper export of required configuration options (darkMode, content, theme, presets, plugins)
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify the existence of the Tailwind configuration file and check its content
# Check if the tailwind config exists
if [ -f "apps/docs-old/tailwind.config.js" ]; then
echo "✓ Tailwind config exists"
# Show the content to verify it's properly configured
cat "apps/docs-old/tailwind.config.js"
else
echo "✗ Missing tailwind.config.js in apps/docs-old/"
fi
Length of output: 1103
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/admin-console.mdx (1)
23-30: LGTM!
The Event Management section is well-structured and clearly describes the functionality.
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/development-timeline.mdx (3)
7-12: LGTM! Clear project name mapping
The project codenames and their corresponding functionalities are well-documented and easy to understand.
1-3: Clarify the archived status of this document
The document is marked as "(Archived)" but contains future dates and planning information. This might cause confusion for readers.
✅ Verification successful
The "(Archived)" status is correctly marked
This document is indeed correctly marked as archived as it's part of the "cuHacking-2020-wiki" collection and contains a historical development timeline for the 2020 event (with dates from July 2019 to January 2020). The timeline is appropriately preserved as historical documentation.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Check if there are any newer versions of this timeline
fd -e mdx -e md "development-timeline" | grep -v "2020-wiki"
Length of output: 58
Script:
#!/bin/bash
# Let's check the content of the file to understand the timeline dates
cat "apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/development-timeline.mdx"
# Also check if this is part of a larger archived section
fd -e mdx -e md . apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/
Length of output: 4876
40-40: Verify critical dates and deadlines
Several important deadlines are mentioned:
- Domain renewal (Oct 7)
- Event test run (Nov 26)
- Mobile app launch (TBD)
These dates should be verified and synchronized with the team's current planning tools.
Also applies to: 43-43, 46-46
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/getting-started/how-to-google-docs.mdx (1)
13-17: Verify image assets existence and accessibility
All images use proper alt text and consistent path structure, but we should verify their existence in the repository.
Also applies to: 25-29, 35-39, 51-55, 63-67
✅ Verification successful
Image assets verified and accessible
All referenced images exist in the correct location at apps/docs/public/cuhacking-2020-images/. The image paths in the MDX file correctly correspond to the actual files in the repository.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check if all referenced images exist in the repository
# Search for image files matching the pattern
fd -e png . | grep -E "google-docs-(insert-table-of-contents|outline|applying-formats|comments|assigning-tasks)\.png"
Length of output: 839
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/getting-started/how-to-google-sheets.mdx (1)
21-25: Verify and update the image path.
The image path /cuhacking-2020-images/google-sheets-decimal-places.png appears to be from an old wiki. This needs to be updated to match the current documentation structure.
✅ Verification successful
Image path is correctly configured
The image path /cuhacking-2020-images/google-sheets-decimal-places.png is valid as the file exists at apps/docs/public/cuhacking-2020-images/google-sheets-decimal-places.png. The path follows the correct structure since files in the public directory are served at the root path in web applications.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Check if the image exists in the repository
fd -t f "google-sheets-decimal-places.png"
# Look for other image paths to understand the correct structure
rg -g "*.mdx" -g "*.md" '<img.*src=".*"'
Length of output: 1669
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/operations/email-template-inviting-a-professor-to-judge.mdx (1)
19-24: LGTM! Well-structured judging criteria
The judging criteria are clearly defined and well-organized, providing excellent guidance for potential judges.
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/design/design-guide.mdx (1)
1-86: Overall document structure is well-organized
The document provides a clear and comprehensive guide to the design process. The structure is logical, progressing from brainstorming through to finalization. While there are some formatting and grammatical issues to address, the content itself is valuable and well-organized.
🧰 Tools
🪛 LanguageTool
[typographical] ~7-~7: Consider adding a comma here.
Context: ...system For reference to the brand guide please visit link --- ## ∆ The ...
(PLEASE_COMMA)
[uncategorized] ~24-~24: Possible missing comma found.
Context: ...take place during a weekly or bi-weekly basis depending on deadlines. --- ### Draft...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~30-~30: In American English, abbreviations like “etc.” require a period.
Context: ...(To see where things are put in a page, etc). - Keep in mind this stage is very ...
(ETC_PERIOD)
[style] ~37-~37: Try using a synonym here to strengthen your writing.
Context: ...n. This will allow the external team to give feedback on the design without clutteri...
(GIVE_PROVIDE)
[style] ~38-~38: Try using a synonym here to strengthen your writing.
Context: ...d must approve of the current design or give feedback for the second draft stage. Th...
(GIVE_PROVIDE)
[style] ~45-~45: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...p. - This draft should still be kept very simple. --- ### Feedback loop - Round 2 -...
(EN_WEAK_ADJECTIVE)
[style] ~63-~63: In American English, abbreviations like “etc.” require a period.
Context: ... in the required format (PDF, PNG, SVG, etc). --- # The design system Coming soon...
(ETC_PERIOD)
apps/docs/app/layout.tsx (2)
1-4: LGTM! Imports are well-organized and necessary.
The imports cover all required dependencies for the layout component.
12-14: Verify selector stability for e2e tests.
Since this PR aims to fix failing tests due to broken selectors, ensure that the new layout's DOM structure and class names don't introduce new selector conflicts.
✅ Verification successful
Layout changes appear safe for existing test selectors
The test suite currently uses basic component rendering without complex selectors. The new layout's structure (<html>, <body>, and RootProvider) adds standard HTML elements with simple class names that are unlikely to interfere with component-level tests.
- The only test file (
apps/docs/specs/index.spec.tsx) uses basic component mounting without specific element queries - The layout adds standard semantic HTML elements with common class names (
flex flex-col min-h-screen) - No complex selectors or data-testid attributes are currently in use
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Search for existing selectors in e2e tests that might be affected by the new layout
rg -t ts -t tsx "querySelector|getBy|findBy|queryBy" "apps/docs/**/*.(spec|test|e2e).(ts|tsx)"
Length of output: 124
Script:
#!/bin/bash
# Search for test files first
fd ".(spec|test|e2e)\.(ts|tsx)$" apps/docs/
# Then search for selectors in e2e tests with correct ripgrep syntax
rg -t typescript "querySelector|getBy|findBy|queryBy" apps/docs/ --glob "*{spec,test,e2e}.{ts,tsx}"
Length of output: 213
Script:
#!/bin/bash
# Let's examine the content of the test file we found
cat apps/docs/specs/index.spec.tsx
# Also search for selectors without file type restriction
rg "querySelector|getBy|findBy|queryBy" apps/docs/specs/index.spec.tsx
Length of output: 378
apps/docs-old/tailwind.config.js (1)
11-19: LGTM! Content configuration is well-structured
The content configuration correctly includes:
- React component patterns
- MDX components
- Dependencies via NX utilities
- Fumadocs UI components
apps/docs/content/docs/concepts/conventional-commits.mdx (3)
43-78: Well-structured decision tree and comprehensive type definitions!
The decision tree flowchart and type definitions table provide clear guidance for selecting appropriate commit types.
118-145: Excellent examples that reinforce the guidelines!
The examples effectively demonstrate the commit message format for various scenarios, making it easy for contributors to understand and follow the conventions.
1-145: Well-structured and comprehensive documentation!
This documentation effectively explains conventional commits through a combination of clear guidelines, visual diagrams, and practical examples. The minor grammatical and formatting issues noted above don't detract from its overall usefulness.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~24-~24: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ommit messages will become second nature and you'll no longer need to use Commitizen...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~33-~33: Possible missing article found.
Context: ...e commit history clean and concise. - Only exception to this is if the commit alre...
(AI_HYDRA_LEO_MISSING_THE)
[grammar] ~33-~33: The verb ‘amend’ does not usually follow articles like ‘an’. Check that ‘amend’ is spelled correctly; using ‘amend’ as a noun may be non-standard.
Context: ...fixup commit should be made rather than an amend. If that commit is amended and force pu...
(A_INFINITIVE)
[grammar] ~36-~36: The preposition ‘to’ may be missing (allow someone to do something).
Context: ... is well worth the effort. It allows us unlock some pretty powerful DevOps which saves...
(ALLOW_TO_DO)
[uncategorized] ~36-~36: Possible missing comma found.
Context: ...t allows us unlock some pretty powerful DevOps which saves the entire team a lot of ti...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~36-~36: ‘in the long run’ might be wordy. Consider a shorter alternative.
Context: ...ich saves the entire team a lot of time in the long run. ### Decision Tree To ease the proces...
(EN_WORDINESS_PREMIUM_IN_THE_LONG_RUN)
[style] ~109-~109: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... the scope should be docs,web,portal. If you have changes in docs, and web ,...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/index.mdx (2)
1-4: LGTM! Well-structured frontmatter.
The metadata is appropriately defined with clear title and description.
6-6: Verify the existence and correct export of constants
Let's ensure that all imported constants are properly defined in the referenced file.
✅ Verification successful
All imported constants are properly defined in constants.ts
The verification shows that all constants imported in the file (GETTING_STARTED, COLEADS, DESIGN, DEVELOPMENT, HACKER_EXPERIENCE, LOGISTICS, MARKETING, OPERATIONS, SPONSORSHIP) are correctly exported from constants.ts in the same directory. Each constant is defined as a URL path using a base URL variable.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check if constants.ts exists and contains all required exports
# Expected: File exists with all constants defined
# Check if file exists
fd -e ts "constants.ts" apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/
# If found, check for required exports
rg "export const (GETTING_STARTED|COLEADS|DESIGN|DEVELOPMENT|HACKER_EXPERIENCE|LOGISTICS|MARKETING|OPERATIONS|SPONSORSHIP)" apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/
Length of output: 2054
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/getting-started/how-to-trello.mdx (2)
10-10: Verify image path and accessibility.
The image path /cuhacking-2020-images/trello-preview.JPG needs verification.
✅ Verification successful
Image path is valid and accessible
The image file trello-preview.JPG exists at the correct location in apps/docs/public/cuhacking-2020-images/, which matches the referenced path in the markdown file. The public directory is the standard location for static assets in most web frameworks, making this path structure correct and accessible.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Verify if the image exists and is accessible
fd -e JPG -e jpg "trello-preview.JPG"
Length of output: 157
10-10: Verify all image paths and accessibility.
Multiple image references need verification to ensure they are accessible.
Also applies to: 39-39, 45-45, 55-55, 63-63, 71-71, 77-77, 128-128, 135-135, 144-144, 159-159, 160-160
✅ Verification successful
Let me verify the actual image references in the MDX file to ensure they match with the available images.
All image paths are valid and accessible
All Trello-related image references in the MDX file have corresponding image files in the correct public directory (apps/docs/public/cuhacking-2020-images/). The paths are consistent and properly formatted. No issues found with image accessibility.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Verify if all referenced images exist and are accessible
echo "Checking for all referenced Trello images..."
fd -e JPG -e jpg . | grep -i "trello"
Length of output: 1654
Script:
#!/bin/bash
# Check all image references in the MDX file
echo "Checking image references in the MDX file..."
rg -U "!\[.*?\]\(/cuhacking-2020-images/trello.*?\)" "apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/getting-started/how-to-trello.mdx"
Length of output: 942
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/particles.mdx (1)
1-17: Verify documentation's relation to failing test suite
Given that the PR's objective is to fix failing test suites due to broken selectors, please clarify how this documentation relates to the test fixes.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~12-~12: It appears that hyphens are missing in the adjective “up-to-date”.
Context: ...ly incompatible is IE 6, 7, 8. For more up to date information on canvas support, [take a ...
(UP_TO_DATE_HYPHEN)
apps/docs/content/docs/concepts/clean-code.mdx (1)
1-5: LGTM!
The metadata is properly formatted and the title/icon choice is appropriate for the content.
apps/docs/content/docs/glossary.mdx (1)
1-53: Verify alignment with PR objectives
While this documentation is valuable, it seems disconnected from the PR's primary objective of repairing failing test suites due to broken selectors. Consider:
- Adding specific terms related to selector strategies
- Including common selector-related issues and solutions
- Documenting best practices for maintaining stable selectors
🧰 Tools
🪛 LanguageTool
[style] ~26-~26: Consider removing “of” to be more concise
Context: ...ectory within a workspace that contains all of the project-specific files. | | ...
(ALL_OF_THE)
[misspelling] ~31-~31: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’.
Context: ... | | Workspace | Area in an Nx project containing apps and libs, co...
(EN_A_VS_AN)
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/map-software.mdx (2)
24-28: LGTM! Clear and practical implementation guidance
The floor selection implementation is well-explained and provides appropriate references to Mapbox documentation.
1-87: Verify documentation alignment with test suite repairs
Given that this PR aims to repair failing test suites due to broken selectors, please ensure that the implementation details documented here, particularly the feature properties and selectors used for floor selection, align with the actual fixes being made to the test suite.
🧰 Tools
🪛 LanguageTool
[misspelling] ~5-~5: This word is normally spelled with a hyphen.
Context: ...visual components: the basemap, and our custom building layers. The basemap will be used to dis...
(EN_COMPOUNDS_CUSTOM_BUILDING)
[misspelling] ~5-~5: This word is normally spelled with a hyphen.
Context: ..., and other immediate surroundings. Our custom building layers will show the floor plans of the...
(EN_COMPOUNDS_CUSTOM_BUILDING)
[uncategorized] ~11-~11: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...mapbox.com/) produces various tools and open source libraries for creating and displaying M...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~11-~11: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...playing maps. They also provide similar open source SDKs for [Android](https://docs.mapbox....
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[misspelling] ~31-~31: This word is normally spelled with a hyphen.
Context: ...mes are clean, minimalistic, and really good looking. Our custom layers will be featured on...
(EN_COMPOUNDS_GOOD_LOOKING)
[style] ~74-~74: Consider a shorter alternative to avoid wordiness.
Context: ...popup-on-click/). ### Floor Selection In order to allow users to select which floor they'...
(IN_ORDER_TO_PREMIUM)
[misspelling] ~75-~75: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...or they'd like to view, we will provide a overlaid selection bar on the top right...
(EN_A_VS_AN)
[style] ~77-~77: Consider removing “of” to be more concise
Context: ...th only a FillLayer and LineLayer using all of the polygon data that we have. Currently w...
(ALL_OF_THE)
[uncategorized] ~78-~78: A comma may be missing after the conjunctive/linking adverb ‘Currently’.
Context: ... all of the polygon data that we have. Currently we will only need to handle displaying ...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[style] ~80-~80: This phrase is redundant. Consider writing “At this point”, “At this time”, or “now”.
Context: ...erent floor selection considerations. At this point in time (mid-July) we won't worry about the qua...
(AT_THIS_POINT_IN_TIME)
[style] ~83-~83: The phrase “take into consideration” may be wordy. To make your writing clearer, consider replacing it.
Context: ...ween several of them. Another thing to take into consideration when determining how to load the `.geoj...
(TAKE_INTO_CONSIDERATION)
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/getting-started/how-to-slack.mdx (2)
7-7: Verify image accessibility
The image path /cuhacking-2020-images/slack-preview.png suggests a specific directory structure. Ensure this path is correct and the image is accessible.
✅ Verification successful
Image path is correct and accessible
The image /cuhacking-2020-images/slack-preview.png exists at the correct location in apps/docs/public/cuhacking-2020-images/slack-preview.png, which means it will be properly served when referenced in the documentation. The path in the markdown file is correctly structured relative to the public directory.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Check if the image exists in the public directory
fd -t f "slack-preview.png" public/
Length of output: 130
Script:
#!/bin/bash
# Let's first find where the image might be located
fd -t f "slack-preview.png"
# Also check the docs directory structure
ls -R apps/docs/public/
Length of output: 1401
1-157: Verify all referenced images exist
The document references multiple images with paths like /cuhacking-2020-images/*.png. Let's ensure all these images are present and accessible.
✅ Verification successful
All referenced images are present and accessible
All images referenced in the Slack documentation are properly available in both the current (apps/docs/public/cuhacking-2020-images/) and old (apps/docs-old/public/cuhacking-2020-images/) public directories. Each image was found in both locations, ensuring the documentation's visual content is complete and functional.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Extract and verify all image paths
rg -o '/cuhacking-2020-images/[^"]+' . | while read -r img; do
echo "Checking: $img"
fd -t f "${img##*/}" public/
done
Length of output: 41296
Script:
#!/bin/bash
# Let's try a different approach to find the images directory
# First, find any directory containing the images
fd -t d cuhacking-2020-images
# Also check if images exist in any other common static directories
fd -t d "static|assets|public|images"
Length of output: 448
Script:
#!/bin/bash
# Now that we found the images directory, let's check if all referenced images exist
# Extract image names from the markdown file and check if they exist in either of the public directories
rg -o '/cuhacking-2020-images/[^)"]+' apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/getting-started/how-to-slack.mdx | while read -r img; do
img_name=$(basename "$img")
echo "Checking for image: $img_name"
# Check in both possible locations
fd "$img_name" apps/docs/public/cuhacking-2020-images/ apps/docs-old/public/cuhacking-2020-images/
done
Length of output: 5758
🧰 Tools
🪛 LanguageTool
[grammar] ~11-~11: Did you mean the communication tool “Slack” (= proper noun, capitalized)?
Context: ...eywords You can use some keywords in a slack message either to get people’s attentio...
(ON_SKYPE)
[grammar] ~45-~45: Did you mean the communication tool “Slack” (= proper noun, capitalized)?
Context: ...re two ways of editing messages sent on slack. ### Up-arrow You can edit the last m...
(ON_SKYPE)
[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)
[uncategorized] ~88-~88: Possible missing comma found.
Context: ...of the line. - This is a list item - This an indented list item This is how you ...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~109-~109: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...te to a channel or DM or to use Slack’s very powerful search feature. 
[grammar] ~115-~115: “Google” is a proper noun and needs to be capitalized.
Context: ...ing Google Drive You can link your own google account to the slack workspace in order...
(A_GOOGLE)
[style] ~122-~122: Consider a shorter alternative to avoid wordiness.
Context: ...blebot to create and share doodle polls in order to find time slots that work for most peop...
(IN_ORDER_TO_PREMIUM)
[style] ~126-~126: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...Polls You can create a poll for voting very easily. They're created with the /poll comma...
(EN_WEAK_ADJECTIVE)
[uncategorized] ~136-~136: Consider adding a hyphen.
Context: ...: 1. Press the workspace button in the top left corner and go to Preferences (or Pres...
(TOP_LEFT_CORNER)
[grammar] ~151-~151: Did you mean “Copy and paste”?
Context: ...e themes that match our colour schemes. Copy paste either of these into the text box to us...
(COPY_PASTE)
apps/docs/app/(docs)/layout.tsx (2)
3-3: Verify pageTree structure for test stability.
The source.pageTree import might affect test stability. Ensure it provides consistent data during tests.
15-34: Verify status of commented sidebar configuration.
There's a significant amount of commented code related to sidebar configuration. This should either be:
- Removed if it's no longer needed
- Implemented if it's planned functionality
- Converted to a TODO comment if it's for future reference
✅ Verification successful
Remove commented out sidebar configuration code
The code shows a clear transition from one documentation layout style to another:
- The
RootToggleimport is commented out - The layout was changed from
fumadocs-ui/layouts/docstofumadocs-ui/layouts/notebook(as evidenced by the comment and actual import) - The sidebar configuration was part of the old layout and is no longer needed with the notebook layout
Since this is a completed transition to a new layout style and the commented code is no longer relevant, it should be removed to maintain code cleanliness.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Check if sidebar configuration exists elsewhere in the codebase
rg -l "RootToggle.*options.*pages\.map" --type tsx
Length of output: 80
Script:
#!/bin/bash
# Search for RootToggle component usage and definition
rg "RootToggle" --type ts --type tsx -A 5
# Search for any sidebar configuration in the codebase
rg "sidebar\s*[=:]" --type ts --type tsx -A 5
# List all TypeScript and TSX files to understand the file structure
fd "\.(ts|tsx)$"
Length of output: 8031
Script:
#!/bin/bash
# Search for RootToggle and sidebar configuration using grep instead
grep -r "RootToggle" apps/docs/
grep -r "sidebar\s*[=:{]" apps/docs/
# Check the content of the layout file to understand the context better
cat apps/docs/app/\(docs\)/layout.tsx
Length of output: 1577
apps/docs/app/layout.config.tsx (1)
116-119: Verify if home layout requires additional customization.
The homeOptions currently just spreads baseOptions without any specific customization. Verify if this meets all requirements for the home layout.
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/co-leads/transitions.mdx (1)
76-76: Verify and update external document links.
Several links to Google Docs appear to be from 2020. These should be updated or removed if they're no longer accessible.
Also applies to: 110-110, 135-135, 229-230
.gitignore (1)
82-83: Verify the impact of Storybook path changes
The change from **/*/storybook-static to storybook-static might affect nested Storybook builds. Please ensure this doesn't impact any subprojects.
✅ Verification successful
Storybook path change in .gitignore is safe
The codebase shows a single-root Storybook setup with story files distributed across different feature libraries. There's no evidence of nested Storybook configurations or multiple Storybook instances that would require the previous **/*/storybook-static pattern. The simplified storybook-static pattern is sufficient for this monorepo structure.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Search for any nested storybook-static directories that might be affected
fd -t d "storybook-static" -d 3
# Check if there are any Storybook configurations in subdirectories
fd -t f "\.storybook" -d 3
Length of output: 60
Script:
#!/bin/bash
# Let's try a different approach to find Storybook-related configurations
# Search for package.json files that might contain Storybook dependencies or scripts
rg -l "storybook" --type json
# Search for any Storybook configuration files with different extensions
fd -e js -e ts -e cjs -e mjs ".storybook"
# Look for build scripts or configurations mentioning Storybook
rg -l "storybook" --type js --type ts
Length of output: 1593
.github/workflows/BUILD.yml (2)
34-35: LGTM: Efficient build strategy
The new build step using nx affected is a good optimization that builds only the necessary projects.
31-32: Verify the affected project detection for linting
The switch to nx affected is good for efficiency, but ensure it correctly identifies all relevant projects for linting.
✅ Verification successful
The nx.json shows proper configuration for linting through the @nx/eslint plugin, but we need to verify:
- The project structure to understand what projects are included
- The lint configurations to ensure they're properly set up
- Recent changes that would trigger the affected detection
This will help us determine if the switch to nx affected will correctly identify all relevant projects for linting.
The previous commands had syntax errors. Let's try again to understand:
- The project structure and configurations
- What projects are in the workspace
- The nature of the change in the e2e test file
This will help us determine if nx affected will properly detect and lint the relevant projects based on the changes.
The switch to nx affected for linting is safe and appropriate
The verification shows that:
- The change is isolated to an e2e test file (
apps/docs-e2e/src/docs.spec.ts) - The workspace is properly configured with the @nx/eslint plugin in nx.json
- The project structure shows clear dependencies between apps and their e2e counterparts (e.g., docs and docs-e2e)
The nx affected command will correctly identify and lint the changed e2e test file and its dependencies, making it more efficient than running lint on all projects while maintaining the same quality checks.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Check for nx.json configuration to verify affected project detection
cat nx.json 2>/dev/null || echo "nx.json not found"
# Look for project dependencies that might affect the detection
fd -t f "project.json" | xargs cat 2>/dev/null | grep -A 5 '"dependencies":'
Length of output: 2518
Script:
#!/bin/bash
# Check for project.json files to understand project structure
fd -t f "project.json" -x echo "=== {} ===" \; cat "{}"
# Check for lint configurations
fd -t f ".eslintrc.json|eslint.config.js" -x echo "=== {} ===" \; cat "{}"
# Check for recent changes that might affect linting
git diff --name-only HEAD~1 HEAD
Length of output: 480
Script:
#!/bin/bash
# Fix the fd commands with proper syntax
fd -t f "project.json" -x sh -c 'echo "=== {} ==="; cat "{}"' \;
# List all projects in the workspace
find . -name "project.json" -type f -exec dirname {} \;
# Check the specific e2e test file that changed
cat apps/docs-e2e/src/docs.spec.ts
Length of output: 16352
.github/workflows/TEST_E2E.yml (1)
40-49: Document rationale for commenting out specific E2E tests
The removal of specific E2E test runs and their artifact uploads needs explanation:
- Are these tests now covered by the affected-based approach?
- Will debugging capabilities be impacted without artifacts?
Also applies to: 67-76
✅ Verification successful
E2E tests have been replaced with an affected-based approach
The commented out E2E tests have been replaced with a more efficient affected-based testing strategy:
- The new approach
pnpm nx affected -t testruns tests only for projects affected by changes - This change improves CI efficiency by avoiding running all E2E tests on every push
- Test artifacts are still generated with the
--reporter=htmlflag for debugging purposes
The rationale is clear from the workflow file: instead of running individual E2E tests for docs, portal, and website separately, the workflow now uses Nx's affected-based testing to run tests only for changed projects while maintaining the HTML reporting capability.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Check for E2E test configurations in commented sections
rg -A 5 "e2e:" apps/docs/project.json apps/website/project.json apps/portal/project.json
Length of output: 153
Script:
#!/bin/bash
# Let's first find the project configuration files
fd -e json project.json
# Then check for any E2E test configurations in the entire codebase
rg -i "e2e:" -A 5
# Also look for playwright configuration files
fd -e config.ts -e config.js | rg -i playwright
Length of output: 1799
Script:
#!/bin/bash
# Let's check the content of the E2E project configurations
cat apps/docs-e2e/project.json apps/website-e2e/project.json
# Check for any recent changes or commits related to E2E tests
git log --oneline -n 10 | grep -i "e2e"
# Check the workflow file for any other E2E related configurations
cat .github/workflows/TEST_E2E.yml
Length of output: 2864
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/getting-started/how-to-wiki.mdx (1)
30-31: Verify GitHub repository links
The link to the wiki repository needs verification as it might be outdated.
✅ Verification successful
GitHub repository link is valid and accessible
The link https://github.com/cuhacking/cuHacking-wiki/tree/master/resources is verified to be correct as:
- The repository exists and is accessible
- The 'master' branch is still the default branch
- The 'resources' directory exists in the master branch
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Check if the repository exists and is accessible
gh repo view cuhacking/cuHacking-wiki &> /dev/null
if [ $? -eq 0 ]; then
echo "Repository exists and is accessible"
else
echo "Repository might be private or doesn't exist"
fi
Length of output: 138
Script:
#!/bin/bash
# Check if the repository has a 'resources' directory in the master branch
gh api /repos/cuhacking/cuHacking-wiki/contents/resources?ref=master &> /dev/null
if [ $? -eq 0 ]; then
echo "Resources directory exists in master branch"
else
echo "Resources directory might not exist in master branch"
fi
# Also check the default branch name as it might have changed from 'master'
gh api /repos/cuhacking/cuHacking-wiki | jq -r .default_branch
Length of output: 259
🧰 Tools
🪛 LanguageTool
[uncategorized] ~31-~31: Possible missing comma found.
Context: ...g-wiki/tree/master/resources) - On this page you'll see a button labeled `Upload fil...
(AI_HYDRA_LEO_MISSING_COMMA)
apps/docs/content/docs/concepts/monorepo-architecture.mdx (1)
1-11: LGTM!
The frontmatter and imports are well-structured and appropriate for the document's purpose.
apps/docs/content/docs/index.mdx (1)
1-20: LGTM! Well-structured metadata and imports.
The metadata and imports are properly organized and follow documentation best practices.
| ### Registration | ||
| * When does registration open? | ||
| * When does registration close? | ||
| * When are responses coming out? | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add essential registration-related questions
The Registration section is missing some crucial questions that hackers typically ask:
Consider adding these important questions:
### Registration
* When does registration open?
* When does registration close?
* When are responses coming out?
+* **Who can participate?**
+* **Is there a registration fee?**
+* **What information do I need to provide during registration?**
+* **Can I modify my registration after submitting?**
+* **Is there an age 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.
| ### Registration | |
| * When does registration open? | |
| * When does registration close? | |
| * When are responses coming out? | |
| ### Registration | |
| * When does registration open? | |
| * When does registration close? | |
| * When are responses coming out? | |
| * **Who can participate?** | |
| * **Is there a registration fee?** | |
| * **What information do I need to provide during registration?** | |
| * **Can I modify my registration after submitting?** | |
| * **Is there an age requirement?** |
| ### Event | ||
| * Slack link for attendees? | ||
| * Is the parking covered? | ||
| * Where can I find parking? | ||
| * Where can I find the schedule? |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Expand event-specific information
The Event section is missing critical information that hackers need during the event.
Add these important questions:
### Event
* Slack link for attendees?
* Is the parking covered?
* Where can I find parking?
* Where can I find the schedule?
+* **What's the WiFi information?**
+* **Where can I find mentors?**
+* **What are the submission requirements?**
+* **Are there any specific rules or guidelines?**
+* **What prizes are available?**
+* **Where can I find food/refreshments?**
+* **What if I need technical support?**📝 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.
| ### Event | |
| * Slack link for attendees? | |
| * Is the parking covered? | |
| * Where can I find parking? | |
| * Where can I find the schedule? | |
| ### Event | |
| * Slack link for attendees? | |
| * Is the parking covered? | |
| * Where can I find parking? | |
| * Where can I find the schedule? | |
| * **What's the WiFi information?** | |
| * **Where can I find mentors?** | |
| * **What are the submission requirements?** | |
| * **Are there any specific rules or guidelines?** | |
| * **What prizes are available?** | |
| * **Where can I find food/refreshments?** | |
| * **What if I need technical support?** |
| --- | ||
| title: Hacker FAQs | ||
| --- | ||
|
|
||
| ### Registration | ||
| * When does registration open? | ||
| * When does registration close? | ||
| * When are responses coming out? | ||
|
|
||
| ### Leading up to Event | ||
| * Are you accepting walk-ins? | ||
| * What time should I show up at? | ||
| * Where should I show up at? | ||
| * Do I need to bring my resume? | ||
| * What should I bring? | ||
| * I forgot to respond to the RSVP, can I still come? | ||
| * Do I need a team beforehand? | ||
| * Will you be sending buses? | ||
| * Is there travel reimbursement? | ||
|
|
||
| ### Event | ||
| * Slack link for attendees? | ||
| * Is the parking covered? | ||
| * Where can I find parking? | ||
| * Where can I find the schedule? |
There was a problem hiding this comment.
Add answers to the FAQ questions
The document currently only lists questions without providing any answers, which defeats the purpose of an FAQ. Each question should be followed by a clear, concise answer to provide value to hackers.
Consider using this format for better readability:
### Registration
-* When does registration open?
+* **When does registration open?**
+ Registration opens on [date] at [time]. Early bird registration will be available until [date].
-* When does registration close?
+* **When does registration close?**
+ Regular registration closes on [date] at [time]. Late registration may be available based on capacity.Committable suggestion skipped: line range outside the PR's diff.
🧰 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)
| icon: GitPullRequestArrow | ||
| --- | ||
|
|
||
| import { Accordion, Accordions } from "fumadocs-ui/components/accordion"; |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Remove unused imports
The Accordion and Accordions components are imported but never used in the document.
-import { Accordion, Accordions } from "fumadocs-ui/components/accordion";| Please feel free to contact me if you have any questions or if you are interested in attending as a mentor or as a judge (or both). | ||
|
|
||
| Thank you for your time, | ||
|
|
||
| David Casciano | ||
|
|
||
| cuHacking Operations |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Template signature and improve closing message
-Please feel free to contact me if you have any questions or if you are interested in attending as a mentor or as a judge (or both).
+Please contact me with any questions or to express your interest in participating as a mentor, judge, or both.
Thank you for your time,
-David Casciano
+[YOUR_NAME]
-cuHacking Operations
+[YOUR_ROLE]
+cuHacking Operations Team📝 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.
| Please feel free to contact me if you have any questions or if you are interested in attending as a mentor or as a judge (or both). | |
| Thank you for your time, | |
| David Casciano | |
| cuHacking Operations | |
| Please contact me with any questions or to express your interest in participating as a mentor, judge, or both. | |
| Thank you for your time, | |
| [YOUR_NAME] | |
| [YOUR_ROLE] | |
| cuHacking Operations Team |
| }) | ||
| `` | ||
|
|
||
| pom.ts is used to create specific variables to represent different elements in the page. |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Expand POM explanation
The Page Object Model (POM) explanation is too brief. Consider adding:
- What POM is and why it's used
- Example of a page object
- Best practices for organizing page objects
| export const HOW_TO_GOOGLE_DOCS = `${CUHACKING_2020_WIKI_URL}/getting-started/how-to-google-docs` | ||
| export const HOW_TO_GOOGLE_SHEETS = `${CUHACKING_2020_WIKI_URL}/getting-started/how-to-google-sheets` | ||
| export const LEADERSHIP_TEAM_MANAGEMENT = `${CUHACKING_2020_WIKI_URL}/getting-started/leadership-team-management` | ||
| export const CUSA_FUNDING_NON_TUITION_FEES = `${CUHACKING_2020_WIKI_URL}getting-started//cusa-funding-non-tuition-fees` |
There was a problem hiding this comment.
Fix double slash in URL path
There's a double slash in the URL path which could cause navigation issues.
Apply this diff to fix the path:
-export const CUSA_FUNDING_NON_TUITION_FEES = `${CUHACKING_2020_WIKI_URL}getting-started//cusa-funding-non-tuition-fees`
+export const CUSA_FUNDING_NON_TUITION_FEES = `${CUHACKING_2020_WIKI_URL}/getting-started/cusa-funding-non-tuition-fees`Committable suggestion skipped: line range outside the PR's diff.
|
|
||
| Our codebase is constantly changing and evolving. Keep your fork up-to-date with the main repository. | ||
|
|
||
| See [Knowledge Base - Learn Git](/knowledge-base#-learn-git) and for resources. |
There was a problem hiding this comment.
Fix broken link format.
The line contains a dangling "and" in the link reference.
-See [Knowledge Base - Learn Git](/knowledge-base#-learn-git) and for resources.
+See [Knowledge Base - Learn Git](/knowledge-base#-learn-git) for resources.📝 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.
| See [Knowledge Base - Learn Git](/knowledge-base#-learn-git) and for resources. | |
| See [Knowledge Base - Learn Git](/knowledge-base#-learn-git) for resources. |
| </div> | ||
|
|
||
| <div className="step"> | ||
| Install [Node.js](https://nodejs.org/en) V22.11.0. |
There was a problem hiding this comment.
Update Node.js version requirement.
The specified Node.js version (22.11.0) appears to be incorrect as it's higher than the current latest stable version (20.x.x).
-Install [Node.js](https://nodejs.org/en) V22.11.0.
+Install [Node.js](https://nodejs.org/en) V20.10.0 or later.📝 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.
| Install [Node.js](https://nodejs.org/en) V22.11.0. | |
| Install [Node.js](https://nodejs.org/en) V20.10.0 or later. |
| The ***coolest*** team of cuHacking. We design effcient and creative material, but overall, make things ***look sick***. | ||
|
|
||
| This year we will be designing all the graphics, swag, marketing, and, web pages. |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Maintain professional tone in documentation.
While enthusiasm is good, consider using more professional language:
-The ***coolest*** team of cuHacking. We design effcient and creative material, but overall, make things ***look sick***.
+The Design team at cuHacking creates efficient and creative materials with a focus on visual excellence.
-This year we will be designing all the graphics, swag, marketing, and, web pages.
+We are responsible for designing graphics, merchandise, 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 ***coolest*** team of cuHacking. We design effcient and creative material, but overall, make things ***look sick***. | |
| This year we will be designing all the graphics, swag, marketing, and, web pages. | |
| The Design team at cuHacking creates efficient and creative materials with a focus on visual excellence. | |
| We are responsible for designing graphics, merchandise, marketing materials, and web pages. |
JeremyFriesenGitHub
changed the title
|
see discord testing channel for potential errors/issues with tests |
JeremyFriesenGitHub
changed the title
JeremyFriesenGitHub
changed the base branch from
main
to
mfarabi/refactor/181-migrate-to-fumadocs-v14
MFarabi619
force-pushed
the
mfarabi/refactor/181-migrate-to-fumadocs-v14
branch
7 times, most recently
from
001bbc1 to
2ca5f47
Compare
MFarabi619
force-pushed
the
cheenoxd/docs-e2e/184-repair-failing-suite-due-to-broken-selectors
branch
from
d7cd95a to
3913623
Compare
MFarabi619
merged commit d43aa65
into
cuhacking:mfarabi/refactor/181-migrate-to-fumadocs-v14
Pull Request Template
PR Requirements Checklist
Summary by CodeRabbit
New Features
Bug Fixes
Documentation
Chores
.gitignorefiles to streamline version control processes.