feat(docs): add cuhacking google calendar #192
Conversation
cheenoxd
requested review from
MFarabi619 and
JeremyFriesenGitHub
as code owners
📝 Walkthrough📝 WalkthroughWalkthroughThe documentation site's Changes
Poem
Tip CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command 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: 34
🧹 Outside diff range and nitpick comments (85)
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/particles.mdx (4)
5-9: Consider enhancing the documentation with version info and usage example.The introduction provides good context and resources. To make it even more helpful:
- Consider adding the version of Particles.js being used in cuHacking projects.
- Include a basic code example to demonstrate the typical usage pattern.
12-12: Fix hyphenation in "up-to-date".Add hyphens to the compound adjective "up-to-date".
-For more up to date information on canvas support +For more up-to-date information on canvas support🧰 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)
11-14: Consider making browser compatibility information more maintainable.Instead of specifying IE versions, consider rephrasing to focus on the technical requirements (HTML canvas support) and directing readers to the CanIUse link for current browser compatibility information. This approach would make the documentation more maintainable as browser landscapes change.
🧰 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)
16-17: Enhance React integration documentation.Consider the following improvements to make this section more comprehensive and maintainable:
- Remove the specific date reference as it may become outdated.
- Add a basic React implementation example.
- Consider mentioning alternative packages or newer solutions.
Example structure:
# Particles in React React applications can use Particles.js through the [react-particles-js](https://github.com/Wufe/react-particles-js) package. Here's a basic example: ```jsx import Particles from 'react-particles-js'; const ParticlesBackground = () => ( <Particles params={{ // Your particles configuration }} /> );apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/getting-started/how-to-wiki.mdx (4)
7-23: Consider expanding Markdown examples.While the WIP example is helpful, consider adding more common Markdown examples that contributors will frequently use (e.g., headers, lists, code blocks, links).
39-39: Fix typo in commit message format.Remove the duplicate word "the" in the sentence.
-Label your commit with the the format +Label your commit with the format🧰 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)
68-71: Refine language and grammar in the Gotchas section.While the warnings are valuable, there are several improvements to be made:
-Links break really easily with GitHub wiki +Links break easily with GitHub wiki -put it in a google doc +put it in a Google Doc -There's no sitemap so it becomes difficult +There's no sitemap, so it becomes difficult🧰 Tools
🪛 LanguageTool
[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)
71-71: Consider adding additional helpful sections.The documentation could be enhanced with:
- A section on how to review/preview changes before committing
- Guidelines for organizing content and choosing appropriate page locations
- Examples of well-structured wiki pages
Would you like assistance in drafting these additional sections?
🧰 Tools
🪛 LanguageTool
[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/roadmap/index.mdx (2)
1-5: Consider enhancing the introduction sectionWhile the introduction provides a basic context, consider:
- Making the Trello board link more prominent by moving it to a dedicated "Resources" or "Quick Links" section
- Adding a brief overview of what readers can expect from this document
--- title: Roadmap --- -_How our roadmap is organized so it's clear and useful for the cuHacking team._ [[trello board](https://trello.com/b/6fbmSGfq)]. +_How our roadmap is organized so it's clear and useful for the cuHacking team._ + +## Quick Links +- [📋 Trello Board](https://trello.com/b/6fbmSGfq) - Our main task tracking board + +## Overview +This document outlines our roadmap organization system, including our task management structure, labeling conventions, and how we track progress throughout the year.
26-52: Fix grammatical issues and improve formattingThere are several grammatical and formatting issues that need attention:
-Since this tool should be useful for retrospecting it is important that the lists not become filled too much with since many tasks will be hidden since only 3-5 cards can be shown at a time. +Since this tool should be useful for retrospecting, it is important that the lists don't become overcrowded, as only 3–5 cards can be shown at a time. -It can be when a deadline was missed, you should create a note as to why it was missed and how it could be avoided next time -If something went really well create a note so that we can continue doing the right things +- When a deadline is missed, create a note explaining why it was missed and how to avoid similar issues in the future +- When something goes well, document the success factors to maintain good practices -These should be where all future and past tasks should be. -This will allow the team to see what is upcoming, as well as see what progress has been made. +These lists contain all future and past tasks, allowing the team to: +- Track upcoming work +- Monitor progress +- Review completed tasks🧰 Tools
🪛 LanguageTool
[uncategorized] ~26-~26: Possible missing comma found.
Context: ...s Since this tool should be useful for retrospecting it is important that the lists not beco...(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~26-~26: The negated form ‘not’ seems to be incomplete.
Context: ...specting it is important that the lists not become filled too much with since many ...(DT_NN_NOT_VB)
[typographical] ~26-~26: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...ce many tasks will be hidden since only 3-5 cards can be shown at a time. The list...(HYPHEN_TO_EN)
[uncategorized] ~43-~43: A comma might be missing here.
Context: ...ided next time If something went really well create a note so that we can continue d...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~43-~43: A period might be missing here.
Context: ...so that we can continue doing the right things ### notes This list will be used to w...(AI_EN_LECTOR_MISSING_PUNCTUATION_PERIOD)
apps/docs/app/(docs)/[[...slug]]/page.tsx (1)
43-43: Remove commented-out codeThe
lastUpdateprop is commented out. If it is no longer needed, consider removing it to keep the codebase clean and maintainable.Apply this diff to remove the commented code:
- /* lastUpdate={new Date()} */apps/docs-old/specs/index.spec.tsx (2)
7-10: Enhance test coverage with additional assertionsCurrently, the test only verifies that the
Pagecomponent renders without crashing. To improve test coverage, consider adding assertions that check specific elements or content within the rendered component to ensure it behaves as expected.For example:
it('should render successfully', () => { const { baseElement, getByText } = render(<Page />) expect(baseElement).toBeTruthy() + expect(getByText('Expected Text in Page')).toBeInTheDocument() })
4-9: Ensure required context providers or mocks are included in testsThe
Pagecomponent may rely on Next.js features or context providers (e.g., routing, global state). To prevent potential issues during testing, consider wrapping the component with necessary providers or mocking Next.js modules to fully simulate the runtime environment.For example:
+ import { MemoryRouterProvider } from 'next-router-mock/MemoryRouterProvider' it('should render successfully', () => { const { baseElement } = render( + <MemoryRouterProvider> <Page /> + </MemoryRouterProvider> ) expect(baseElement).toBeTruthy() })apps/docs/app/home/page.tsx (1)
7-18: Simplify JSX by removing unnecessary string concatenationsThe usage of
{' '}to include spaces in the JSX can be simplified for better readability. You can write the text content as a single string and include the<Link>component inline without extra string literals.Apply this diff to simplify the code:
<p className="text-fd-muted-foreground"> - You can open - {' '} - <Link - href="/docs" - className="text-fd-foreground font-semibold underline" - > - /docs - </Link> - {' '} - and see the documentation. + You can open <Link href="/docs" className="text-fd-foreground font-semibold underline">/docs</Link> and see the documentation. </p>apps/docs/app/layout.tsx (1)
12-12: Review the necessity ofsuppressHydrationWarningThe
suppressHydrationWarningattribute on the<html>tag suppresses warnings about content mismatches between server-rendered and client-rendered HTML. It's generally better to address the root cause of hydration issues rather than suppressing the warnings. Verify if this attribute is necessary, and consider removing it if not required.Apply this diff if the attribute is unnecessary:
- <html lang="en" className={jetBrainsMono.className} suppressHydrationWarning> + <html lang="en" className={jetBrainsMono.className}>apps/docs-old/postcss.config.cjs (1)
1-15: LGTM! Consider adding a brief comment about the config path resolution.The PostCSS configuration is well-structured with proper plugin setup. The use of
path.joinensures cross-platform compatibility.Consider adding a brief comment explaining why the explicit path resolution is needed:
const { join } = require('node:path') +// Resolve tailwind config path relative to this file to ensure cross-platform compatibility module.exports = { plugins: { tailwindcss: { config: join(__dirname, 'tailwind.config.js'), }, autoprefixer: {}, }, }apps/docs/app/(docs)/layout.tsx (2)
4-6: Document the layout choice rationale.The switch from
docstonotebooklayout should be documented. While there's a link to the Fumadocs documentation, it would be helpful to explain why the notebook layout was chosen for this specific use case.-/* https://fumadocs.vercel.app/docs/ui/blocks/layout#notebook */ +/** + * Using notebook layout instead of docs layout for better content organization + * and improved readability of documentation pages. + * @see https://fumadocs.vercel.app/docs/ui/blocks/layout#notebook + */
15-34: Consider removing or implementing the commented sidebar configuration.Large blocks of commented code can make maintenance more difficult. Either implement the sidebar feature or remove the commented code and track it in an issue for future implementation.
Would you like me to help create an issue to track the sidebar implementation as a future enhancement?
apps/docs/content/docs/concepts/trunk-based-development.mdx (3)
3-3: Consider revising the description to be more professionalThe current description "Fun fact, Git doesn't scale for colossal monorepos" could be more professional and informative. Consider something like: "A guide to our trunk-based development workflow and its benefits"
17-17: Fix typo in "lifing"Correct the typo in "heavy lifing" to "heavy lifting"
-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.
20-20: Add missing articleAdd "The" at the beginning of the sentence for better grammar
-Majority of time is generally spent debugging. +The majority of time is generally spent debugging.🧰 Tools
🪛 LanguageTool
[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)
.github/workflows/BUILD.yml (1)
37-44: Remove commented out codeIf these specific build steps are no longer needed due to the switch to
nx affected, they should be removed rather than left commented out. This helps maintain cleaner workflow files.apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/admin-console.mdx (3)
11-11: Fix typo in "bellow"Correct the spelling of "bellow" to "below"
-The Admin Console will take care of the tasks bellow. +The Admin Console will take care of the tasks below.
14-14: Fix grammar in user referencesAdd apostrophes to show possession
-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.🧰 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)
31-34: Add security considerations for Data ManagementThe documentation should include information about access control, audit logging, and security considerations for the admin console, especially given its powerful capabilities for managing user data and applications.
Consider adding a new section about security that covers:
- Role-based access control
- Audit logging of administrative actions
- Data encryption requirements
- Session management
- API security measures
🧰 Tools
🪛 LanguageTool
[style] ~32-~32: In American English, abbreviations like “etc.” require a period.
Context: ...s checked in for food from what groups, etc) but these have yet to be fully planned...(ETC_PERIOD)
apps/docs/content/docs/contribution-guidelines/authoring-documentation.mdx (3)
1-5: Add more descriptive metadataThe frontmatter could be more informative. Consider expanding the description to better explain the purpose and scope of this guide.
--- title: Authoring Documentation -description: Bridge the gap between your brain and the rest of us. WIP. +description: A comprehensive guide on writing clear, effective documentation for the cuHacking project. Learn best practices for formatting, structure, and content organization. icon: PencilLine ---
9-12: Improve the callout messageThe current message about rebasing is abrupt and could be more constructive.
<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 `main`. + This helps prevent conflicts and ensures you're working with the latest content. </Callout>
37-44: Enhance code example documentationThe code example could be more educational by explaining the highlighting syntax.
Add a brief explanation before the code block:
The following example demonstrates various code block features: - Use `title="..."` to label your code blocks - Add `// [!code highlight]` comments to highlight specific lines - Use `// [!code --]` and `// [!code ++]` to show changesapps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/dashboard.mdx (1)
35-39: Expand WIP sectionsThe Hardware Checkout and Mini-events sections need more detail or should be removed if not implemented.
Consider adding basic information about the planned functionality or remove these sections until they're ready for implementation. Would you like me to help draft content for these sections or create GitHub issues to track their completion?
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/getting-started/how-to-zoho.mdx (1)
25-26: Clarify signature formattingThe color and font specifications could be clearer.
-Purple (12pt, Verdana), Gray (10.5pt, Verdana), and Black (10.5pt, Verdana) – this preserves the colours for the cuhacking colour scheme. +Format your signature using these specifications: +- Name: Purple, 12pt Verdana +- Title: Gray, 10.5pt Verdana +- Contact Info: Black, 10.5pt Verdana + +These colors maintain consistency with the cuHacking brand identity..github/workflows/TEST_E2E.yml (1)
Line range hint
40-76: Document rationale for commenting out specific E2E testsMultiple E2E test sections (docs, portal, website) have been commented out rather than removed. Please:
- Document the reasoning behind disabling these specific tests
- Create tracking issues for re-enabling them if they're still needed
- Consider removing the commented code if these tests are permanently deprecated
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/getting-started/cusa-funding-non-tuition-fees.mdx (1)
5-5: Fix grammar in opt-out usageThe term "opt-out" is incorrectly used as a verb. When used as a verb, it should be "opt out" (with a space). Please update the following instances:
-Due to the government's Student Choice Initiative we can now opt-out of certain +Due to the government's Student Choice Initiative we can now opt out of certain -we are able to opt-out of funding CUSA +we are able to opt out of funding CUSA -do not opt-out of CUSA's +do not opt out of CUSA's -must not opt-out of CUSA's +must not opt out of CUSA's -that do not opt-out of CUSA's +that do not opt out of CUSA's -fees you want to opt-out of +fees you want to opt out ofAlso applies to: 11-11, 13-13, 15-15, 16-16, 24-24
🧰 Tools
🪛 LanguageTool
[uncategorized] ~5-~5: Possible missing comma found.
Context: ..._Due to the government’s Student Choice Initiative we can now opt-out of certain student f...(AI_HYDRA_LEO_MISSING_COMMA)
[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)
apps/docs/content/docs/contribution-guidelines/coding-standards/end-to-end-testing.mdx (1)
13-41: Enhance the architecture documentation with additional best practicesThe proposed architecture follows good practices with POM pattern, but could benefit from additional clarification:
- Test data management:
- How should test data be organized (e.g., fixtures vs. factories)?
- What's the strategy for handling test data cleanup?
- Visual testing:
- What tool is being used for visual regression tests?
- What's the threshold for visual differences?
Consider adding these sections to make the documentation more comprehensive.
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/coding-guidelines.mdx (1)
41-55: Enhance PR template with additional sectionsThe current PR template is good but could be more comprehensive.
Add these sections to the template:
# Feature A one line description of the feature being made in the PR. # Description A description of what you had to do to accomplish this feature. - Were there any hiccups? - Did you have to deviate from the origin concept of the feature? - Is this related to any other PRs? (link them here). # Tests - How did you test your feature? - What new unit tests did you make? - What are the steps to reproducing your manual tests? + +# Breaking Changes +- List any breaking changes introduced +- Migration steps required + +# Screenshots/Videos +- Add visual evidence of the changes + +# Checklist +- [ ] Tests added and passing +- [ ] Documentation updated +- [ ] No new console warnings/errorsapps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/getting-started/how-to-google-sheets.mdx (2)
21-25: Ensure image accessibility with descriptive alt textThe current alt text "Screen Shot 2019-10-24 at 10 49 10 PM" is not descriptive of the image content. Consider updating it to describe what the image shows, such as "Decimal places adjustment buttons in Google Sheets toolbar".
- alt="Screen Shot 2019-10-24 at 10 49 10 PM" + alt="Decimal places adjustment buttons in Google Sheets toolbar"
45-45: Fix grammatical issues for better readabilitySeveral sentences need grammatical improvements:
- Line 45: Add a comma after "For example"
- Line 51: "time" should be "times"
- Line 57: Add a comma before "such as"
- Line 61: Add a comma before "but"
-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 -to a range such as using +to a range, such as using -looking at applicant data but you only +looking at applicant data, but you onlyAlso applies to: 51-51, 57-57, 61-61
🧰 Tools
🪛 LanguageTool
[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)
apps/docs/app/layout.config.tsx (3)
32-33: Track TODO comment about CMS integrationThe TODO comment about using CMS should be tracked for future implementation.
Would you like me to create a GitHub issue to track the CMS integration task?
66-71: Consider removing commented code for Utils sectionInstead of keeping commented code for the upcoming Utils section, consider tracking this as a separate task and removing the commented code.
- /* { - * text: 'Utils (Coming Soon)', - * url: 'https://utils.cuhacking.ca', - * icon: <UtilsIcon />, - * }, */Would you like me to create a GitHub issue to track the Utils section implementation?
101-105: Consider shortening the Figma URLThe Figma URL is quite long and could potentially break. Consider using a URL shortener service or moving it to a configuration file.
apps/docs/content/docs/concepts/monorepo-architecture.mdx (2)
12-19: Consider enhancing the iframe implementationThe iframe to monorepo.tools could benefit from:
- A fallback message for when the iframe fails to load
- Better accessibility support
<iframe title="Monorepos Explained Website" className="mt-4 w-full h-[400px] rounded-lg" src="https://monorepo.tools/" + loading="lazy" + sandbox="allow-scripts allow-same-origin" allowFullScreen> + <p>Your browser doesn't support iframes. Visit <a href="https://monorepo.tools/">Monorepos Explained</a> to learn more.</p> </iframe>
25-27: Consider expanding the key principles sectionThe principles listed are important but would benefit from brief explanations to help readers understand their significance in the context of monorepo architecture.
apps/docs/content/docs/concepts/clean-code.mdx (2)
6-6: Remove or complete WIP sectionsThe document contains two WIP (Work in Progress) sections. Consider either:
- Completing these sections with full content
- Removing the WIP marker and adding a TODO comment for future updates
Also applies to: 52-53
42-42: Fix grammar in JetBrains IDE descriptionThe text should use "to-dos" instead of "TODOs" for consistency with standard English grammar.
- Documentation on how JetBrains products like IntelliJ IDEA handle TODOs and other code annotations. + Documentation on how JetBrains products like IntelliJ IDEA handle to-dos and other code annotations.🧰 Tools
🪛 LanguageTool
[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/glossary.mdx (1)
31-31: Fix article usageReplace "an" with "a" before "Nx project" as "Nx" is pronounced starting with a consonant sound.
- Area in an Nx project containing apps and libs, configured in `nx.json`. + Area in a Nx project containing apps and libs, configured in `nx.json`.🧰 Tools
🪛 LanguageTool
[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/postman.mdx (4)
17-17: Fix grammar in the sentenceAdd a hyphen to make it "Postman-specific" as it's used as a modifier.
-Before we get into Postman specific things +Before we get into Postman-specific things🧰 Tools
🪛 LanguageTool
[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)
19-23: Consider adding code examples for the testing stepsWhile the testing steps are well explained, adding code examples would make them more concrete and easier to understand.
Consider adding examples like this:
// 1. Setup const token = "your-auth-token"; const requestBody = { id: 123 }; // 2. Function call const response = await postman.send("/api/endpoint", { method: "POST", headers: { Authorization: `Bearer ${token}` }, body: JSON.stringify(requestBody) }); // 3. Check result pm.test("Status code is 200", () => { pm.response.to.have.status(200); });
28-28: Complete the WIP section with essential Postman conceptsThis section could benefit from covering essential Postman concepts like:
- Collections and environments
- Request methods and parameters
- Pre-request scripts
- Test scripts
Would you like me to help generate content for these topics or create a GitHub issue to track this task?
31-33: Make the instructions more conciseThe instructions can be made more concise while maintaining clarity.
-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. - -Postman tests come as JSON files. In order to run them, you just need to open up Postman, and **import** them with the button in the top-left. +To run Postman tests: +1. Install Postman +2. Download the test collection (and environment if provided) +3. Import the JSON files using the top-left **Import** button🧰 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)
apps/docs/content/docs/contribution-guidelines/coding-standards/index.mdx (1)
22-24: Add version information for ESLintConsider adding version information for ESLint and related tools to help users avoid compatibility issues.
-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, as most of them have been automated by [ESLint](https://eslint.org/). +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, as most of them have been automated by [ESLint](https://eslint.org/) (v8.x).🧰 Tools
🪛 LanguageTool
[uncategorized] ~22-~22: A comma might be missing here.
Context: ...e will be read more than it is written. Thankfully you don't have to memorize all of the c...(AI_EN_LECTOR_MISSING_PUNCTUATION_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/knowledge-base/cuHacking-2020-wiki/dev-team/website.mdx (2)
9-9: Fix grammatical error in the sentenceThere's a typo in "before the attend".
-From here people will be able to decide if the event is good *before* the attend the event. +From here people will be able to decide if the event is good *before* they attend the event.
74-76: Fix grammar in the Applications sectionThere are several grammatical issues in these paragraphs.
-Aspiring hackers will have create an account +Aspiring hackers will have to create an account -The account will require a first name, last name, email address, phone number, and require the user to create a password. +The account requires a first name, last name, email address, phone number, and password.🧰 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/knowledge-base/cuHacking-2020-wiki/getting-started/how-to-slack.mdx (3)
11-11: Fix capitalization of "Slack" throughout the document"Slack" is a proper noun and should be capitalized consistently throughout the document.
-You can use some keywords in a slack message either to get people's attention +You can use some keywords in a Slack message either to get people's attention -There are two ways of editing messages sent on slack. +There are two ways of editing messages sent on Slack. -You can link your own google account to the slack workspace +You can link your own Google account to the Slack workspaceAlso applies to: 45-45, 72-72, 115-115
🧰 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)
73-74: Fix formatting inconsistencies in code formatting instructionsThe formatting instructions contain inconsistencies in the explanation of syntax.
-Use the * symbol before and after some text to bold it. i.e. `*Bold\*` +Use the * symbol before and after some text to make it bold. Example: `*Bold*` -Use the _ symbol before and after some text to bold italicize it. i.e. `\_Italics_` +Use the _ symbol before and after some text to italicize it. Example: `_Italics_` -Use the ~ symbol before and after some text to bold it. i.e. `~Strikethrough~` +Use the ~ symbol before and after some text to add strikethrough. Example: `~Strikethrough~`Also applies to: 77-78, 81-82
151-157: Consider adding color scheme preview imagesThe theme color codes are provided, but adding preview images would help users visualize the themes before applying them.
Consider adding screenshots of both light and dark themes to help users make an informed choice.
🧰 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/contribution-guidelines/pull-requests.mdx (1)
14-14: Improve clarity in rebase instructionsThe sentence structure could be improved for better clarity.
-Always simple rebase your branch onto main before creating a pull request. This ensures that your branch is up-to-date with the latest changes in the main branch. Branch and PR rules are set up for the repo just in case as a guardrail. +Always rebase your branch onto main before creating a pull request. This ensures your branch is up-to-date with the latest changes. Branch and PR rules are set up in the repository as guardrails to enforce this practice.🧰 Tools
🪛 LanguageTool
[uncategorized] ~14-~14: A comma might be missing here.
Context: ...R rules are set up for the repo just in case as a guardrail. Do your best to close ...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/getting-started/leadership-team-management.mdx (2)
72-75: Fix typos and improve clarity in the Bystander Effect sectionThere are several issues in this section that need to be addressed.
-Oftentimes, it is easy to to `@channel` on slack and ask "who can complete this task?". Unfortunately this usually does not work due to the bystander effect. Everyone assumes someone else will respond, but in the end no one does. +Oftentimes, it is easy to use `@channel` on Slack and ask "who can complete this task?". Unfortunately, this usually does not work due to the bystander effect. Everyone assumes someone else will respond, but ultimately no one does. -The best way to find someone to complete a task, is to ask them directly; this can be done in a private message on slack or using `@name` in your team channel. +The best way to find someone to complete a task is to ask them directly; this can be done in a private message on Slack or using `@name` in your team channel.🧰 Tools
🪛 LanguageTool
[duplication] ~72-~72: Possible typo: you repeated a word
Context: ...Bystander Effect Oftentimes, it is easy to to@channelon slack and ask “who can co...(ENGLISH_WORD_REPEAT_RULE)
[typographical] ~72-~72: Consider adding a comma after ‘Unfortunately’ for more clarity.
Context: ... and ask “who can complete this task?”. Unfortunately this usually does not work due to the b...(RB_LY_COMMA)
[style] ~72-~72: Consider replacing this phrase to strengthen your wording.
Context: ... assumes someone else will respond, but in the end no one does. The best way to find some...(IN_THE_END_EVENTUALLY)
[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)
87-93: Consider adding a table of contents for resourcesThe resources section would benefit from better organization.
Consider organizing resources into categories with a table of contents:
# 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. +These resources can help you develop your leadership skills. They are organized by type: + +## Videos * [How Great Leaders Inspire Action (TED Talk)](https://www.youtube.com/watch?v=qp0HIF3SfI4) + +## Books * [How to Win Friends and Influence People (eBook)](https://drive.google.com/file/d/1VL1TTiZHS4FcO-nBFh2yRhKOB9zy_O3-/view) + +## Podcasts * [WorkLife with Adam Grant (podcast)](https://www.ted.com/series/worklife_with_adam_grant)apps/docs/content/docs/concepts/conventional-commits.mdx (1)
24-24: Consider improving the sentence structure.Add 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)
apps/docs/content/docs/contribution-guidelines/getting-started.mdx (2)
148-150: Fix duplicate word "Branch".Remove the duplicate word for better readability.
-## Create a Branch Branch from `main` with the following name format: +## Create a Branch from `main` with the following name format:🧰 Tools
🪛 LanguageTool
[duplication] ~148-~148: Possible typo: you repeated a word
Context: ...issue by commenting on it. ## Create a Branch Branch frommainwith the following name for...(ENGLISH_WORD_REPEAT_RULE)
177-177: Address the TODO comment for Google Calendar link.The calendar link needs to be added to help contributors stay updated with volunteer meetings.
Would you like me to help create a GitHub issue to track this task?
apps/docs/content/docs/installation.mdx (1)
245-245: Fix typographical error.Replace double dots with a single dot or 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)
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/map-software.mdx (2)
5-5: Fix compound word hyphenation.For better readability and grammatical correctness, add hyphens to compound words:
- "basemap" → "base-map"
- "custom building" → "custom-building"
🧰 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)
38-41: Add code examples for layer implementations.The documentation would benefit from concrete code examples showing:
- How to create and configure each layer type (FillLayer, LineLayer, SymbolLayer)
- How to implement floor filtering
- How to handle feature properties
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/getting-started/how-to-trello.mdx (2)
33-37: Standardize terminology for list names.For consistency, use hyphenated "to-do" instead of "todo" throughout the document. Also, consider using title case for list names consistently:
- "todo" → "To-Do"
- "ready" → "Ready"
- "in progress" → "In Progress"
- "blocked" → "Blocked"
- "done" → "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)
[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 
79-82: Add section about card templates.Consider adding information about Trello card templates to standardize task creation. This would help ensure consistency in:
- Required information
- Checklist structure
- Label usage
🧰 Tools
🪛 LanguageTool
[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)
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/co-leads/transitions.mdx (1)
120-124: Add recommended timeline for onboarding process.Include a timeline that specifies:
- When to start the onboarding process
- Duration of transition meetings
- Deadlines for account setup
- Milestones for knowledge transfer
🧰 Tools
🪛 LanguageTool
[typographical] ~122-~122: There might be a comma missing.
Context: ...o lose interest and once you need tasks done they won’t be committed to the team any...(IF_PRP_PRP_COMMA)
apps/docs/content/docs/index.mdx (2)
1-4: Consider enhancing the metadata descriptionThe current description "Leave none behind regardless of our development cost" is somewhat vague. Consider making it more specific to the documentation's purpose.
-description: Leave none behind regardless of our development cost. +description: Comprehensive documentation for cuHacking 2025's platform, focusing on accessibility and inclusivity.
320-324: Track TODOs in GitHub issuesConsider tracking these TODOs as GitHub issues for better visibility and tracking.
Would you like me to help create GitHub issues for:
- Adding project demos and screenshots
- Implementing auto-generated contributor profiles?
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/mobile-app.mdx (1)
102-107: Add security considerations for QR code implementationWhile the QR code display is well-documented, consider adding security recommendations:
- Implement rate limiting for QR code scanning
- Add expiration timestamps to QR codes
- Document encryption requirements for sensitive data in QR codes
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/index.mdx (2)
18-18: Fix grammar: "lead" should be "led"The past tense of "lead" should be "led" in this context.
-The cuHacking organization is lead by two <Link href={COLEADS}>Coleads</Link> +The cuHacking organization is led by two <Link href={COLEADS}>Coleads</Link>🧰 Tools
🪛 LanguageTool
[grammar] ~18-~18: Make sure that the noun ‘lead’ is correct. Did you mean the past participle “leaded”, “led”?
Context: ... # Teams The cuHacking organization is lead by two Coleads</Li...(BE_VB_OR_NN)
20-34: Consider improving the team links presentationThe current structure using multiple
<br>tags isn't ideal for accessibility and maintainability. Consider using an unordered list instead.-<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/knowledge-base/cuHacking-2020-wiki/dev-team/development-timeline.mdx (2)
33-33: Add comma before "i.e."For better readability and proper punctuation.
-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)
51-51: Fix typo: "Tenative" should be "Tentative"Correct the spelling error.
-_* Tenative_ +_* Tentative_apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/design/index.mdx (4)
9-9: Consider using more professional languageWhile maintaining a friendly tone is good, terms like "coolest" and "look sick" might be too informal for official documentation.
-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 impactful visual presentation.
34-34: Improve sentence structure and formalityThe current wording could be more professional and concise.
-This tool is going to be used as our main way to get feedback from each other and from the organization as it allows to collaborative feedback. +This tool will serve as our primary platform for collecting collaborative feedback from team members and the organization.🧰 Tools
🪛 LanguageTool
[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)
44-44: Use more formal language and fix grammarReplace informal language and add proper punctuation.
-If you wanna learn more check out our <Link href={DESIGN_GUIDE}>design guide</Link> +If you want to learn more, check out 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)
[uncategorized] ~44-~44: Possible missing comma found.
Context: ...r production cycle. If you wanna learn more check out our <Link href={DESIGN_GUIDE}...(AI_HYDRA_LEO_MISSING_COMMA)
66-66: Consider using a team email instead of personal emailFor sustainability and security reasons, it's better to use a team or organization email address rather than a personal one.
Consider creating and using a design team email address (e.g., [email protected]) instead of a personal email address.
🧰 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)
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/getting-started/how-to-google-docs.mdx (1)
11-11: Fix grammar and style issuesSeveral sentences need grammatical improvements:
- Line 11: "google" should be capitalized to "Google"
- Line 23: Add a comma after "document"
- Line 41: Rewrite to avoid using "will": "the paragraph/text where the cursor is converts to this format"
- Line 57: Add a comma before "and"
- Line 61: Add a comma after "comments"
Also applies to: 23-23, 33-33, 41-41, 57-57, 61-61
🧰 Tools
🪛 LanguageTool
[grammar] ~11-~11: “Google” is a proper noun and needs to be capitalized.
Context: ... a table of contents directly into your google doc by selecting it from the menu optio...(A_GOOGLE)
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/design/design-guide.mdx (1)
51-51: Fix typo in "objective"There's a typo in the word "objective".
- - The objetive of this stage is to finalize the current stage to move the design to the final stage. + - The objective of this stage is to finalize the current stage to move the design to the final stage.apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/application-server.mdx (3)
13-13: Add endpoint documentation linkThe reference to endpoint documentation is marked as "coming soon". Consider adding a TODO or issue to track this.
Would you like me to create a GitHub issue to track the addition of endpoint documentation?
19-19: Fix typo in "appropriately"There's a typo in the word "appropriately".
-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.
16-16: Fix typo in "event"There's a typo in the word "event".
-The database is our primary method of storing data, whether it be for applications, mailing lists, or the event itself. The application server aims to provide all **reasonable** operations that can be done on the data. In general, this means that it provides basic operations such as adding, getting, and removing, as well as some other specific ones that the even might require, such as getting based on a specific constraint. +The database is our primary method of storing data, whether it be for applications, mailing lists, or the event itself. The application server aims to provide all **reasonable** operations that can be done on the data. In general, this means that it provides basic operations such as adding, getting, and removing, as well as some other specific ones that the event might require, such as getting based on a specific constraint.apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/operations/email-template-soliciting-a-high-school-for-judges.mdx (2)
1-5: Enhance template instructions with professional language.Consider these style improvements:
- Replace "Please feel free to" with "You may"
- Replace "any and all" with simply "all"
- Add hyphen to "event-specific"
--- title: Email Template Soliciting a High School for Judges --- -Please feel free to use the template below when emailing High Schools to ask if they'd like to send any judges for the hackathon. _Read through the entire text and make sure to update/omit any and all 2020 event specific information_; this information has been left in to facilitate contextual understanding. +You may use the template below when emailing High Schools to ask if they'd like to send judges for the hackathon. _Read through the entire text and make sure to update/omit all 2020 event-specific information_; this information has been left in to facilitate contextual understanding.🧰 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)
15-18: Enhance writing style and impact.Consider these improvements:
- Remove redundant "of" in "outside of the box"
- Vary sentence structure to avoid repetitive starts with "This"
-During this hackathon, we challenge students to think outside of the box with absolutely no hacking involved. We host more than just one event, we host games, activities and talks. This is an opportunity for students to win cool prizes and make real-world connections. +During this hackathon, we challenge students to think outside the box with absolutely no hacking involved. Beyond the main event, we host games, activities and talks, offering students opportunities to win cool prizes and make real-world connections. -Last year, we noticed the lack of high school participants at the event. This year, our goal is to expand this experience to high school students as well. This year, we would like to change that by inviting high school students from all over Ottawa to attend our hackathon. This is an opportunity for them to not only network but learn what they are interested in. +Last year, we noticed the lack of high school participants at the event. Our goal this year is to expand this experience to high school students as well by inviting students from all over Ottawa to attend our hackathon. The event presents a valuable opportunity for them to network and explore their interests.🧰 Tools
🪛 LanguageTool
[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/operations/email-template-inviting-a-professor-to-judge.mdx (1)
17-24: Standardize judging criteria format.The judging criteria need consistent punctuation and clearer wording:
**Judging** We have many volunteers and mentors to help the students tackle any of the challenges of their projects. We are looking to create a diverse group of professors to judge the student's creations at the end of the hackathon. Projects are evaluated based on their novelty, grit, technical skill, and functionality. -* Novelty: is it a new original idea? -* Grit: how did the team react when they encountered setbacks? -* Technical Ability: how advanced is their project (based on student's experience level) -* Functionality: How complete and functional is the project? +* **Novelty:** Is it a new and original idea? +* **Grit:** How did the team handle challenges and setbacks? +* **Technical Ability:** How advanced is the project relative to the team's experience level? +* **Functionality:** How complete and well-implemented is the project?
📜 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-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)apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/roadmap/index.mdx(1 hunks)apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/sponsorship/index.mdx(1 hunks)apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/sponsorship/signatures.mdx(1 hunks)
⛔ Files not processed due to max files limit (44)
- 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 (29)
- apps/docs/content/docs/contribution-guidelines/code-review.mdx
- apps/docs/content/docs/contribution-guidelines/coding-standards/unit-testing.mdx
- apps/docs/content/docs/contribution-guidelines/coding-standards/front-end.mdx
- apps/docs/content/docs/contribution-guidelines/coding-standards/back-end.mdx
- apps/docs/content/docs/concepts/conventional-comments.mdx
- apps/docs/app/api/search/route.ts
- apps/docs/content/docs/concepts/design-systems.mdx
- apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/marketing/index.mdx
- apps/docs/content/docs/concepts/diataxis-model.mdx
- apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/hacker-experience/index.mdx
- apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/logistics/index.mdx
- apps/docs/content/docs/concepts/meta.json
- apps/docs-old/project.json
- 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/co-leads/index.mdx
- apps/docs/content/docs/contribution-guidelines/coding-standards/meta.json
- apps/docs/content/docs/common-issues.mdx
- apps/docs/content/docs/contribution-guidelines/meta.json
- apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/operations/index.mdx
- apps/docs-old/tsconfig.json
- apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/meta.json
- apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/getting-started/meta.json
- apps/docs/content/docs/features.mdx
- apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/meta.json
- apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/getting-started/index.mdx
- apps/docs-old/tailwind.config.js
- apps/docs/content/docs/contribution-guidelines/coding-standards/tooling.mdx
- apps/docs/.gitignore
🧰 Additional context used
🪛 LanguageTool
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/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/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/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/roadmap/index.mdx
[uncategorized] ~26-~26: Possible missing comma found.
Context: ...s Since this tool should be useful for retrospecting it is important that the lists not beco...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~26-~26: The negated form ‘not’ seems to be incomplete.
Context: ...specting it is important that the lists not become filled too much with since many ...
(DT_NN_NOT_VB)
[typographical] ~26-~26: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...ce many tasks will be hidden since only 3-5 cards can be shown at a time. The list...
(HYPHEN_TO_EN)
[uncategorized] ~43-~43: A comma might be missing here.
Context: ...ided next time If something went really well create a note so that we can continue d...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~43-~43: A period might be missing here.
Context: ...so that we can continue doing the right things ### notes This list will be used to w...
(AI_EN_LECTOR_MISSING_PUNCTUATION_PERIOD)
apps/docs/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)
[uncategorized] ~5-~5: A comma might be missing here.
Context: ...so to make sure we all stay on the same page this page is being created. Here you wi...
(AI_EN_LECTOR_MISSING_PUNCTUATION_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)
[uncategorized] ~37-~37: Possible missing preposition found.
Context: ...descriptions should be meticulous- down the commands that you run. Pretend that the...
(AI_HYDRA_LEO_MISSING_TO)
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/index.mdx
[uncategorized] ~13-~13: Possible missing comma found.
Context: ... the hacker (and organizer) experience. Collectively these services are dubbed cuPlatform....
(AI_HYDRA_LEO_MISSING_COMMA)
[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/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)
[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/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/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/contribution-guidelines/pull-requests.mdx
[uncategorized] ~14-~14: A comma might be missing here.
Context: ...R rules are set up for the repo just in case as a guardrail. Do your best to close ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~38-~38: Possible missing comma found.
Context: ...is solution-specific (describe only the solution since the issue describes the problem a...
(AI_HYDRA_LEO_MISSING_COMMA)
[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/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)
[uncategorized] ~53-~53: Possible missing comma found.
Context: ...ing Conventions (WIP) Constants are all caps with words being separated by underscor...
(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] ~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)
[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)
[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)
[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/knowledge-base/cuHacking-2020-wiki/getting-started/cusa-funding-non-tuition-fees.mdx
[uncategorized] ~5-~5: Possible missing comma found.
Context: ..._Due to the government’s Student Choice Initiative we can now opt-out of certain student f...
(AI_HYDRA_LEO_MISSING_COMMA)
[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/coding-standards/index.mdx
[uncategorized] ~22-~22: A comma might be missing here.
Context: ...e will be read more than it is written. Thankfully you don't have to memorize all of the c...
(AI_EN_LECTOR_MISSING_PUNCTUATION_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/contribution-guidelines/coding-standards/end-to-end-testing.mdx
[uncategorized] ~84-~84: Possible missing article found.
Context: ... PR - Can get the report from here. - Report is produced regardless of whether you p...
(AI_HYDRA_LEO_MISSING_THE)
[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/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/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)
[uncategorized] ~20-~20: Possible missing preposition found.
Context: ...count, so it may be given to a hacker - View internal hacker information - Informa...
(AI_HYDRA_LEO_MISSING_TO)
[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/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)
[uncategorized] ~30-~30: The preposition “about” seems more likely in this position.
Context: ... deadline, or you weren't knowledgeable on what you were asked to do. Did the dire...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
[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)
[uncategorized] ~64-~64: A comma might be missing here.
Context: ... personal reasons or graduation, and as such it is a good opportunity to recruit new...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~84-~84: A comma might be missing here.
Context: ...g should ideally be prepared before the event including the Exec Responsibility doc, ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[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)
[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)
[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)
[uncategorized] ~188-~188: You might be missing the article “a” here.
Context: ...7pHz) # Team Tools ## Slack - Create new slack workspace for the organizing team...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~190-~190: You might be missing the article “a” here.
Context: ...5317-Create-a-Slack-workspace) - Create new slack workspace for the event - Ren...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[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)
[uncategorized] ~227-~227: A comma might be missing here.
Context: ...o the team; if you wait until after the summer many people will have changed their min...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
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)
[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/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] ~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)
[uncategorized] ~165-~165: Possible missing comma found.
Context: ... as the google drive Power-Up. For more information see this [website](https://trello.com/e...
(AI_HYDRA_LEO_MISSING_COMMA)
[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/dev-team/dashboard.mdx
[uncategorized] ~8-~8: Possible missing comma found.
Context: ...few additional services provided by the hackathon including announcements and an interact...
(AI_HYDRA_LEO_MISSING_COMMA)
[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/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)
[uncategorized] ~17-~17: Possible missing comma found.
Context: ...ies have built-in support for rendering GeoJson so we don’t need to do any special work...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~31-~31: “the” seems less likely than “to”.
Context: ...d by the client, i.e. dark will be used the match a dark theme in a mobile app). Th...
(AI_HYDRA_LEO_CP_THE_TO)
[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)
[uncategorized] ~65-~65: Possible missing comma found.
Context: ...ur “featured” marker on top of our data layers we don’t have to worry about any text o...
(AI_HYDRA_LEO_MISSING_COMMA)
[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)
[uncategorized] ~77-~77: Possible missing comma found.
Context: ...ltiLineString, and Points, respectively) but for now, we will start with only a Fill...
(AI_HYDRA_LEO_CPT_BUT_CBUT)
[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] ~78-~78: Loose punctuation mark.
Context: ...asks.', icon: , }, ].map((feature, index) => ( <Feat...
(UNLIKELY_OPENING_PUNCTUATION)
[style] ~89-~89: This phrase is redundant. Consider writing “undergraduates”.
Context: ...al institution. Priority is provided to undergraduate students at [Carleton University](https://carlet...
(UNDERGRADUATE_STUDENT)
[uncategorized] ~142-~142: Loose punctuation mark.
Context: ...h={24} height={24} /> } /> ## UI/UX Design <Ca...
(UNLIKELY_OPENING_PUNCTUATION)
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)
[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] ~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)
[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: 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)
[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] ~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)
[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/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)
[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/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/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/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)
[uncategorized] ~44-~44: Possible missing comma found.
Context: ...r production cycle. If you wanna learn more check out our <Link href={DESIGN_GUIDE}...
(AI_HYDRA_LEO_MISSING_COMMA)
[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-docs.mdx
[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: Possible missing comma found.
Context: ...Outline You can add an outline to your document which appears on the left-hand-side wit...
(AI_HYDRA_LEO_MISSING_COMMA)
[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/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/knowledge-base/cuHacking-2020-wiki/marketing/hacker-faqs.mdx
[uncategorized] ~10-~10: Possible missing article found.
Context: ...esponses coming out? ### Leading up to Event * Are you accepting walk-ins? * What ti...
(AI_HYDRA_LEO_MISSING_THE)
[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)
[uncategorized] ~27-~27: Possible missing comma found.
Context: ... their projects as a mentor, and if you wish you may be able to host a workshop duri...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~28-~28: A comma might be missing here.
Context: ...ring the event. * If you wish to host a workshop feel free to contact me with the topic,...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[style] ~29-~29: The phrase ‘feel free to’ is used quite frequently. Consider using a less frequent alternative to set your writing apart from others and make it sound more professional.
Context: ...e in the schedule we will slot you in. Please feel free to contact me if you have any questions or...
(FEEL_FREE_TO_STYLE_ME)
apps/docs/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 (18)
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/particles.mdx (1)
1-3: LGTM!
The front matter is properly formatted and includes the necessary title metadata.
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/getting-started/how-to-wiki.mdx (2)
1-5: LGTM! Clear and welcoming introduction.
The frontmatter is properly formatted, and the introduction effectively communicates the wiki's purpose while encouraging contributions.
55-65: LGTM! Comprehensive security guidelines.
The section effectively outlines permission rules and emphasizes information security, which is crucial for organizational documentation.
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/roadmap/index.mdx (2)
7-15: LGTM! Well-structured goals section
The goals are clearly defined, specific, and align well with effective project management practices.
16-22: 🛠️ Refactor suggestion
Verify image accessibility and enhance labels documentation
- The image path
/cuhacking-2020-images/roadmap-labels.pngneeds verification - Consider adding a table or list of specific labels with their meanings
Consider adding a structured list of labels:
+
+## Label Categories
+
+### Team Labels
+- Design Team
+- Development Team
+- Marketing Team
+- (add other teams)
+
+### Status Labels
+- ✅ Done
+- 🚧 In Progress
+- ⏳ Upcoming
+- 🚫 Blocked✅ Verification successful
Image path is correct and accessible
The image /cuhacking-2020-images/roadmap-labels.png exists in the correct location at apps/docs/public/cuhacking-2020-images/roadmap-labels.png, and the reference path in the MDX file follows the same pattern as other image references throughout the documentation. The suggestion to add structured label categories would still improve documentation clarity.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Verify if the image exists in the repository
fd -t f "roadmap-labels.png"
Length of output: 148
Script:
#!/bin/bash
# Let's verify if the image path in the MDX file matches the actual image location
rg -l "/cuhacking-2020-images/roadmap-labels.png" apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/roadmap/index.mdx
# Also check if there are any other references to this image path pattern
rg "/cuhacking-2020-images/" apps/docs/content/docs/
Length of output: 7208
apps/docs/app/home/layout.tsx (1)
1-11: Well-structured Layout component
The Layout component correctly wraps the HomeLayout with the spread baseOptions and renders the children appropriately. This implementation follows good practices for component composition in React.
.gitignore (1)
82-83: LGTM! Appropriate Storybook ignore patterns added.
The added ignore patterns for Storybook build artifacts are correct and follow standard practices.
apps/docs/app/(docs)/layout.tsx (1)
10-39: Verify layout configuration integration.
The layout component looks good, but let's verify the integration with baseOptions and page tree configuration.
✅ Verification successful
Let me gather more information about the source and page tree configuration.
Let me check the source configuration file and DocsLayout implementation for a complete verification.
Layout configuration is properly integrated
The verification shows that:
- The
sourceconfiguration is properly set up insource.tswith the correct loader and MDX source baseOptionsis correctly imported and spread into the DocsLayout component- The page tree is correctly passed via
source.pageTree - DocsLayout is properly imported from 'fumadocs-ui/layouts/notebook'
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify layout configuration and tree structure
# Check for baseOptions configuration
echo "Checking layout configuration..."
rg -A 5 "export const baseOptions" apps/docs/
# Check for page tree structure
echo "Checking page tree structure..."
rg -A 5 "pageTree" apps/docs/
Length of output: 880
Script:
#!/bin/bash
# Check for source configuration and imports
echo "Checking source configuration..."
rg -A 5 "source\." apps/docs/
# Check for source imports
echo "Checking source imports..."
rg "import.*source" apps/docs/
# Check for DocsLayout component usage and props
echo "Checking DocsLayout..."
ast-grep --pattern 'interface $_ {
$$$
tree: $_
$$$
}'
Length of output: 2827
Script:
#!/bin/bash
# Check source.ts configuration
echo "Checking source.ts content..."
cat apps/docs/source.ts
# Check .source.ts content
echo "Checking .source.ts content..."
cat apps/docs/.source.ts
# Check DocsLayout import and its location
echo "Checking DocsLayout import..."
rg "import.*DocsLayout" apps/docs/
Length of output: 1827
.github/workflows/BUILD.yml (1)
31-32: LGTM: Improved build efficiency
The switch to nx affected commands is a good improvement as it will only build and lint projects that were actually affected by the changes, making the CI process more efficient.
apps/docs/content/docs/concepts/conventional-branch.mdx (1)
42-42: Verify internal documentation link
Please ensure the knowledge base link is correct and accessible:
✅ Verification successful
Link to Learn Git section is valid and accessible
The link to the Learn Git section in the knowledge base is correct. The referenced section exists in apps/docs/content/docs/knowledge-base/index.mdx with the heading "🌳 Learn Git" and contains relevant learning resources.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Check if the referenced knowledge base section exists
rg -l "Learn Git" apps/docs/content/docs/
Length of output: 285
Script:
#!/bin/bash
# Check the content of knowledge-base/index.mdx to verify the Learn Git section
rg -A 5 "Learn Git" apps/docs/content/docs/knowledge-base/index.mdx
Length of output: 261
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/dev-team/index.mdx (1)
5-5: Verify the constants import statement
The import statement references constants but their source file isn't provided in the PR.
✅ Verification successful
Import statement is correctly referencing existing constants
The import statement is valid as all the referenced constants (CODING_GUIDELINES, WEBSITE, DASHBOARD, MOBILE_APP, APPLICATION_SERVER, ADMIN_CONSOLE, MAP_SOFTWARE, POSTMAN) are properly exported from the constants.ts file located in the same directory (apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/constants.ts).
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Check if constants file exists and verify the imported constants
fd -e ts -e js -e tsx -e jsx -x grep -l "export.*{.*CODING_GUIDELINES.*WEBSITE.*DASHBOARD.*MOBILE_APP.*APPLICATION_SERVER.*ADMIN_CONSOLE.*MAP_SOFTWARE.*POSTMAN.*}"
Length of output: 165
Script:
#!/bin/bash
# Let's first check for the constants.ts file in the same directory
fd constants.ts -p apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/
# Then search for individual constants to see if they are defined anywhere
echo "Searching for individual constants..."
rg "export.*CODING_GUIDELINES" --type ts
rg "export.*WEBSITE" --type ts
rg "export.*DASHBOARD" --type ts
rg "export.*MOBILE_APP" --type ts
rg "export.*APPLICATION_SERVER" --type ts
rg "export.*ADMIN_CONSOLE" --type ts
rg "export.*MAP_SOFTWARE" --type ts
rg "export.*POSTMAN" --type ts
# Also check the content of any constants file in the immediate parent directory
fd constants.ts -p apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki -x cat {}
Length of output: 6113
apps/docs/content/docs/concepts/monorepo-architecture.mdx (1)
29-110: LGTM! Well-structured folder visualization
The folder structure is well-organized and uses appropriate styling to distinguish different sections. The use of icons and color coding helps improve readability.
apps/docs/content/docs/glossary.mdx (1)
42-53: LGTM! Well-structured test automation terms
The test automation section provides clear and concise definitions for common testing terms. The descriptions are accurate and helpful for newcomers.
apps/docs/content/docs/concepts/conventional-commits.mdx (1)
45-57: LGTM! Well-structured commit type definitions.
The table provides clear and concise descriptions for each commit type, making it easy for contributors to choose the appropriate type.
apps/docs/content/docs/installation.mdx (1)
17-17:
Verify Node.js version requirement.
The specified Node.js version (22.11.0) seems incorrect as the latest LTS version is 20.x.x. This might be a typo.
Please verify the correct Node.js version requirement for the project.
✅ Verification successful
Node.js version specification is correct
The package.json indicates that the project supports Node.js versions from 20.0.0 up to 22.11.0, so the installation guide correctly mentions the maximum supported version. However, it would be more helpful to indicate the version range instead of a specific version.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Check package.json for Node.js version requirement
rg -A 1 '"node":' package.json
Length of output: 70
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/getting-started/how-to-google-docs.mdx (1)
13-17: Verify image assets availability
Please ensure that all referenced images exist in the /cuhacking-2020-images/ directory:
- google-docs-insert-table-of-contents.png
- google-docs-outline.png
- google-docs-applying-formats.png
- google-docs-comments.png
- google-docs-assigning-tasks.png
Also applies to: 25-29, 35-39, 51-55, 63-67
✅ Verification successful
All referenced images are present and correctly configured ✅
All the images referenced in the MDX file are present in the correct location at apps/docs/public/cuhacking-2020-images/:
- google-docs-insert-table-of-contents.png
- google-docs-outline.png
- google-docs-applying-formats.png
- google-docs-comments.png
- google-docs-assigning-tasks.png
The image paths in the MDX file are also correctly configured to match the public directory structure.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Check if the referenced images exist in the public directory
for img in "google-docs-insert-table-of-contents.png" "google-docs-outline.png" "google-docs-applying-formats.png" "google-docs-comments.png" "google-docs-assigning-tasks.png"; do
fd -t f "$img" public/
done
Length of output: 1609
Script:
#!/bin/bash
# Let's first find where the images might be stored
fd -t f -e png cuhacking-2020
Length of output: 31
Script:
#!/bin/bash
# Let's also check the repository structure to understand where static assets are stored
fd -t d --max-depth 2
Length of output: 161
Script:
#!/bin/bash
# Search for any configuration files that might indicate the static assets directory
fd -t f -e config.js -e next.config.js -e gatsby-config.js
Length of output: 446
Script:
#!/bin/bash
# Let's check the content of the docs app for static assets directory structure
fd . apps/docs/ --max-depth 2
Length of output: 601
Script:
#!/bin/bash
# Let's also check if images exist in any public directories under apps/docs
fd -t f -e png . apps/docs/public
Length of output: 1681
Script:
#!/bin/bash
# Search for image references in the MDX file to ensure we have the correct path
rg -A 1 "src=\".*?png\"" "apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/getting-started/how-to-google-docs.mdx"
Length of output: 458
apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/operations/email-template-soliciting-a-high-school-for-judges.mdx (1)
19-24: Verify brochure attachment and improve signature block.
- The template mentions a brochure but doesn't specify how to include it
- The signature block could be more professional
-We have included our brochure as well. If you have any more questions, feel free to email me. Looking forward to hearing from you soon.
+[Brochure attached] If you have any questions, please don't hesitate to contact me. I look forward to hearing from you.
Kind Regards,
Anoushka Singhal
-
-Operations Team Member
+Operations Team Member
+cuHacking 2024
+[Your Email]apps/docs/content/docs/knowledge-base/cuHacking-2020-wiki/operations/email-template-inviting-a-professor-to-judge.mdx (1)
1-16: 🛠️ Refactor suggestion
Improve template instructions and document reference.
Several improvements needed:
- Style consistency with previous template
- Clarify the "attached document" reference
- Update date references
---
title: Email Template Inviting a Professor to Judge
---
-Please feel free to use the template below when emailing professors to ask if they'd like to judge during the hackathon. _Read through the entire text and make sure to update/omit any and all 2020 event specific information_; this information has been left in to facilitate contextual understanding.
+You may use the template below when emailing professors to ask if they'd like to judge during the hackathon. _Read through the entire text and make sure to update/omit all 2020 event-specific information_; this information has been left in to facilitate contextual understanding.
***
Hello Professor __________,
I am David Casciano, a member of the cuHacking Operations team. I would like to invite you to attend cuHacking 2020 on January 11 and 12, as a judge or mentor.
cuHacking started in 2017 as Ottawa's first MLH hackathon. From the beginning, our focus has been creating a community of students who are passionate about technology, learning, and teamwork. This year we are expecting over 400 students, from every skill level and field of study.
-Below is more information about judging and mentorship, further information can be found in the attached document.
+Below is more information about judging and mentorship. Additional details can be found in our [Judge's Information Package]. 🧰 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: ...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)
|
|
||
| ### 1. Upload your file to the wiki's repository | ||
|
|
||
| - Go to [this link](https://github.com/cuhacking/cuHacking-wiki/tree/master/resources) |
There was a problem hiding this comment.
Update the repository link.
The link points to cuHacking-wiki which appears to be an old repository. Please update it to point to the current repository.
| export async function generateMetadata(props: { | ||
| params: Promise<{ slug?: string[] }> | ||
| }) { | ||
| const params = await props.params |
There was a problem hiding this comment.
Incorrect use of Promise with params in generateMetadata function
Similar to the Page function, the params prop in generateMetadata should not be a Promise. Update the function signature and remove the unnecessary await to align with Next.js conventions.
Apply this diff to fix the issue:
-export async function generateMetadata(props: {
- params: Promise<{ slug?: string[] }>
-}) {
- const params = await props.params
+export async function generateMetadata({ params }: {
+ params: { slug?: string[] }
+}) {📝 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.
| export async function generateMetadata(props: { | |
| params: Promise<{ slug?: string[] }> | |
| }) { | |
| const params = await props.params | |
| export async function generateMetadata({ params }: { | |
| params: { slug?: string[] } | |
| }) { |
| export default async function Page(props: { | ||
| params: Promise<{ slug?: string[] }> | ||
| }) { | ||
| const params = await props.params |
There was a problem hiding this comment.
Incorrect use of Promise with params in Page function
In Next.js, the params prop is passed synchronously and does not need to be a Promise. The use of params: Promise<{ slug?: string[] }> and awaiting props.params is unnecessary and may cause errors. Consider updating the function signature to accept params directly without wrapping it in a Promise.
Apply this diff to fix the function signature:
-export default async function Page(props: {
- params: Promise<{ slug?: string[] }>
-}) {
- const params = await props.params
+export default async function Page({ params }: {
+ params: { slug?: string[] }
+}) {📝 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.
| export default async function Page(props: { | |
| params: Promise<{ slug?: string[] }> | |
| }) { | |
| const params = await props.params | |
| export default async function Page({ params }: { | |
| params: { slug?: string[] } | |
| }) { |
.github/workflows/BUILD.yml
Outdated
| @@ -17,7 +17,7 @@ jobs: | |||
| - name: 🛎️ Checkout Code | |||
| uses: actions/checkout@v4 | |||
| with: | |||
| fetch-depth: 1 # Shallow clone (only take latest commit) | |||
| fetch-depth: 0 # Shallow clone (only take latest commit) | |||
There was a problem hiding this comment.
Fix incorrect comment about fetch-depth
The comment is incorrect. A fetch-depth of 0 means fetching the complete history, not a shallow clone. This is actually necessary for the nx affected commands to work properly as they need the git history to determine which projects were affected.
- fetch-depth: 0 # Shallow clone (only take latest commit)
+ fetch-depth: 0 # Fetch complete history (required for nx affected commands)📝 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.
| fetch-depth: 0 # Shallow clone (only take latest commit) | |
| fetch-depth: 0 # Fetch complete history (required for nx affected commands) |
| The actual Dashboard. Split into a couple sections which can be reached by visiting different tabs. | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Fix grammatical issues
Several grammatical issues need to be addressed for better readability.
-The actual Dashboard. Split into a couple sections which can be reached by visiting different tabs.
+The actual Dashboard is split into several sections, accessible through different tabs.
-Once logged in users can see their QR Badge
+Once logged-in users can see their QR Badge
-Users can click on any event to find more details for the event. Logged in (and accepted) users can also favourite events so that they can be filtered into a short list and receive a push notification if signed into the app.
+Users can click on any event to find more details about the event. Logged-in (and accepted) users can also favourite events to create a shortlist and receive push notifications when signed in to the app.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)
| ### 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 FAQ questions
The FAQ section currently only lists questions without their corresponding answers. This limits its usefulness for hackers seeking information.
Consider adding detailed answers to each question. For example:
### Registration
* When does registration open?
+ Registration opens on January 15th, 2025 at 12:00 PM EST.
* When does registration close?
+ Registration closes on February 1st, 2025 at 11:59 PM EST.Would you like me to help draft answers for these FAQ questions based on previous hackathon documentation?
Committable suggestion skipped: line range outside the PR's diff.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~10-~10: Possible missing article found.
Context: ...esponses coming out? ### Leading up to Event * Are you accepting walk-ins? * What ti...
(AI_HYDRA_LEO_MISSING_THE)
[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. Brainstorm. | ||
| 2. Draft. | ||
| 3. Feedback loop. | ||
| 5. Draft. | ||
| 4. Finalization and Detailing. |
There was a problem hiding this comment.
Fix process step numbering
The numbering of steps is inconsistent. Step 5 appears before step 4.
1. Brainstorm.
2. Draft.
3. Feedback loop.
- 5. Draft.
- 4. Finalization and Detailing.
+ 4. Draft.
+ 5. Finalization and Detailing.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| 1. Brainstorm. | |
| 2. Draft. | |
| 3. Feedback loop. | |
| 5. Draft. | |
| 4. Finalization and Detailing. | |
| 1. Brainstorm. | |
| 2. Draft. | |
| 3. Feedback loop. | |
| 4. Draft. | |
| 5. Finalization and Detailing. |
|
|
||
| # Our design process and system | ||
|
|
||
| For reference to the brand guide please visit [link](https://) |
There was a problem hiding this comment.
Fix broken brand guide link
The link to the brand guide is empty. Please provide the correct URL.
-For reference to the brand guide please visit [link](https://)
+For reference to the brand guide please visit [Brand Guide](https://actual-url-here)Committable suggestion skipped: line range outside the PR's diff.
🧰 Tools
🪛 LanguageTool
[typographical] ~7-~7: Consider adding a comma here.
Context: ...system For reference to the brand guide please visit link --- ## ∆ The ...
(PLEASE_COMMA)
| My name is Anoushka and I am a student at Carleton University. I am reaching out to you on behalf of cuHacking hosted by Carleton University on January 11 and 12 2020. | ||
|
|
||
| cuHacking is a hackathon held over a weekend where students from different knowledge in coding come together and build a project. This event allows students who are passionate about technology to come together and learn from each other. |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Improve clarity and grammar in the introduction.
The current wording about student knowledge is unclear and there are grammar issues:
- Add comma before "and" in compound sentence
- Rephrase "different knowledge in coding"
-My name is Anoushka and I am a student at Carleton University. I am reaching out to you on behalf of cuHacking hosted by Carleton University on January 11 and 12 2020.
+My name is Anoushka, and I am a student at Carleton University. I am reaching out to you on behalf of cuHacking hosted by Carleton University on January 11 and 12 2020.
-cuHacking is a hackathon held over a weekend where students from different knowledge in coding come together and build a project. This event allows students who are passionate about technology to come together and learn from each other.
+cuHacking is a hackathon held over a weekend where students with varying levels of coding experience come together and build a project. This event allows students who are passionate about technology to come together and learn from each other.📝 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.
| My name is Anoushka and I am a student at Carleton University. I am reaching out to you on behalf of cuHacking hosted by Carleton University on January 11 and 12 2020. | |
| cuHacking is a hackathon held over a weekend where students from different knowledge in coding come together and build a project. This event allows students who are passionate about technology to come together and learn from each other. | |
| My name is Anoushka, and I am a student at Carleton University. I am reaching out to you on behalf of cuHacking hosted by Carleton University on January 11 and 12 2020. | |
| cuHacking is a hackathon held over a weekend where students with varying levels of coding experience come together and build a project. This event allows students who are passionate about technology to come together and learn from each other. |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~11-~11: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... Hello Highschool, My name is Anoushka and I am a student at Carleton University. ...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~13-~13: The preposition “with” seems more likely in this position.
Context: ...thon held over a weekend where students from different knowledge in coding come toge...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
[uncategorized] ~13-~13: The preposition “of” seems more likely in this position.
Context: ...where students from different knowledge in coding come together and build a projec...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
| **Mentorship** | ||
|
|
||
| If you are not interested in judging, we also looking for professors to mentor at the event. You will be able to help students overcome challenges in their projects as a mentor, and if you wish you may be able to host a workshop during the event. | ||
| * If you wish to host a workshop feel free to contact me with the topic, and if there is space in the schedule we will slot you in. | ||
|
|
||
| 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
Improve mentorship section grammar and structure.
The mentorship section needs several improvements:
- Fix grammar ("we also looking" → "we are also looking")
- Replace casual phrases with more professional alternatives
- Better structure workshop information
**Mentorship**
-If you are not interested in judging, we also looking for professors to mentor at the event. You will be able to help students overcome challenges in their projects as a mentor, and if you wish you may be able to host a workshop during the event.
-* If you wish to host a workshop feel free to contact me with the topic, and if there is space in the schedule we will slot you in.
+If you are not interested in judging, we are also looking for professors to mentor at the event. As a mentor, you will help students overcome project challenges. Additionally, you may have the opportunity to host a workshop during the event.
+
+**Workshop Opportunities**
+* Interested in hosting a workshop? Please contact me with:
+ * Proposed topic
+ * Preferred time slot
+ * Estimated duration
-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 if you have any questions or would like to participate as a mentor, judge, or both.
Thank you for your time,
David Casciano
-
-cuHacking Operations
+cuHacking Operations
+[Your Email]📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| **Mentorship** | |
| If you are not interested in judging, we also looking for professors to mentor at the event. You will be able to help students overcome challenges in their projects as a mentor, and if you wish you may be able to host a workshop during the event. | |
| * If you wish to host a workshop feel free to contact me with the topic, and if there is space in the schedule we will slot you in. | |
| 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 | |
| **Mentorship** | |
| If you are not interested in judging, we are also looking for professors to mentor at the event. As a mentor, you will help students overcome project challenges. Additionally, you may have the opportunity to host a workshop during the event. | |
| **Workshop Opportunities** | |
| * Interested in hosting a workshop? Please contact me with: | |
| * Proposed topic | |
| * Preferred time slot | |
| * Estimated duration | |
| Please contact me if you have any questions or would like to participate as a mentor, judge, or both. | |
| Thank you for your time, | |
| David Casciano | |
| cuHacking Operations | |
| [Your Email] |
🧰 Tools
🪛 LanguageTool
[grammar] ~27-~27: An auxiliary verb seems to be missing from this progressive structure. Did you mean “we're also looking”, “we are also looking”, or “we were also looking”?
Context: ... If you are not interested in judging, we also looking for professors to mentor at the event. ...
(PRP_VBG)
[uncategorized] ~27-~27: Possible missing comma found.
Context: ... their projects as a mentor, and if you wish you may be able to host a workshop duri...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~28-~28: A comma might be missing here.
Context: ...ring the event. * If you wish to host a workshop feel free to contact me with the topic,...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[style] ~29-~29: The phrase ‘feel free to’ is used quite frequently. Consider using a less frequent alternative to set your writing apart from others and make it sound more professional.
Context: ...e in the schedule we will slot you in. Please feel free to contact me if you have any questions or...
(FEEL_FREE_TO_STYLE_ME)
JeremyFriesenGitHub
changed the title
There was a problem hiding this comment.
Nice work 🔥
- couple small changes, review what the commit
docs(feat): added calender on home page.is doing, I'm confused why there's no diff that shows up for that. - also for the commit above, please refer to our commit message guide, if you need help you can use
pnpm committo construct the message - don't forget to rebase onto main, I see some conflicts
Overall amazing work, and thank you for your work on this PR, it brings a lot of value to us 🔥 🚀
HasithDeAlwis
force-pushed
the
cheenoxd/feat/80-docs-add-cuhacking-google-calendar
branch
from
11ecda5 to
5a2b77b
Compare
HasithDeAlwis
force-pushed
the
cheenoxd/feat/80-docs-add-cuhacking-google-calendar
branch
from
5a2b77b to
5a7325d
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
apps/docs/content/docs/index.mdx (1)
285-286: Add context for the Calendar sectionConsider adding a brief description explaining the purpose of this calendar (e.g., upcoming events, important dates, team meetings) to help users understand what information they can expect to find here.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
apps/docs/content/docs/index.mdx(2 hunks)
🔇 Additional comments (1)
apps/docs/content/docs/index.mdx (1)
287-294: Enhance iframe security, accessibility, and usability
-
The iframe implementation needs security and accessibility improvements as previously suggested.
-
Consider changing the calendar view mode:
- src="https://calendar.google.com/calendar/embed?height=600&wkst=1&ctz=America%2FToronto&showPrint=0&mode=WEEK&src=ZmNkYmEzZjM1NGQ0ZTAxNTUyZTI0OTVkNzQzMTA1YmQ5ZWZjZTRlMTA3NmNkYTNjMWVjMTQ1NGQwZjVmYWE3M0Bncm91cC5jYWxlbmRhci5nb29nbGUuY29t&color=%237CB342"
+ src="https://calendar.google.com/calendar/embed?height=600&wkst=1&ctz=America%2FToronto&showPrint=0&mode=MONTH&src=ZmNkYmEzZjM1NGQ0ZTAxNTUyZTI0OTVkNzQzMTA1YmQ5ZWZjZTRlMTA3NmNkYTNjMWVjMTQ1NGQwZjVmYWE3M0Bncm91cC5jYWxlbmRhci5nb29nbGUuY29t&color=%237CB342"The MONTH view would provide better visibility of upcoming events at a glance, which is typically more useful for hackathon planning and event schedules.
|
|
||
| <iframe | ||
| className="mt-4 w-full h-[600px] rounded-lg bg-black" | ||
| src="https://calendar.google.com/calendar/embed?height=600&wkst=1&ctz=America%2FToronto&showPrint=0&mode=WEEK&src=ZmNkYmEzZjM1NGQ0ZTAxNTUyZTI0OTVkNzQzMTA1YmQ5ZWZjZTRlMTA3NmNkYTNjMWVjMTQ1NGQwZjVmYWE3M0Bncm91cC5jYWxlbmRhci5nb29nbGUuY29t&color=%237CB342" |
There was a problem hiding this comment.
💡 Codebase verification
Calendar ID should be managed as a configuration variable
The calendar is embedded in the documentation site and appears to be used for displaying team schedules and events. Based on the context:
- The calendar ID is only used in this single location (index.mdx)
- It's part of the public documentation, suggesting the calendar is intentionally public-facing
- However, the calendar ID should be managed as a configuration variable to:
- Make it easier to update across environments
- Follow security best practices by not hardcoding sensitive identifiers
- Enable different calendars for different deployments (staging/production)
Recommendations:
- Move the calendar ID to an environment variable
- Update the iframe src to use the environment variable
- Document the calendar's public visibility requirement in the project documentation
🔗 Analysis chain
Verify calendar sharing settings and access control
Please verify that:
- The calendar is intentionally set to be publicly viewable
- The calendar ID in the URL is meant to be exposed in the public documentation
Consider using environment variables for the calendar ID if it needs to be configurable across different environments.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check if the calendar ID is used elsewhere in the codebase
# This helps determine if it's already being managed as a configuration
# Search for the calendar ID
rg "fcdbA3f354d4e01552e2495d743105bd9efce4e1076cda3c1ec1454d0f5faa73"
Length of output: 69
Script:
#!/bin/bash
# Let's check for any environment variables or configuration files that might contain calendar-related settings
rg -i "calendar" --type=yaml --type=env --type=json
# Also check for any Google Calendar related configurations or embeddings
rg -i "google.*calendar|calendar.*embed" -g '!*.md' -g '!*.mdx'
Length of output: 145
Script:
#!/bin/bash
# Let's check for any configuration files that might contain calendar settings
fd -e yaml -e yml -e json -x rg -i "calendar" {}
# Let's also check the specific file to see its context
cat "apps/docs/content/docs/index.mdx"
Length of output: 11975
|
🎉 This PR is included in version 1.14.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Pull Request Template
PR Requirements Checklist
Summary by CodeRabbit