Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create about page #51

Merged
merged 14 commits into from
Feb 16, 2025
Merged

Create about page #51

merged 14 commits into from
Feb 16, 2025

Conversation

Cykotech
Copy link
Contributor

@Cykotech Cykotech commented Feb 5, 2025

What issue is this solving?

Closes #39

Description

I went ahead and created the About page. It will feature a brief summary of the community, and a card for any of us that wish to share a bit about ourselves. I wasn't sure where to start on the summary, so I left some placeholder text in the meantime.

Staff cards are created when we add our info to staff-info.json which is located in the About directory. All staff info should adhere to the new Staff type which is defined in the new global type file. And any images are stored in the public directory.

Any helpful knowledge/context for the reviewer?

  • Any new dependencies to install? ❌
  • Any special requirements to test? ❌
  • Any UI changes? Include screenshots if so. ✔️

image

The duplicates are just to demonstrate the spacing.

Feelings gif (optional)

Dang Typescript

Please make sure you've attempted to meet the following coding standards

  • Code has been tested and does not produce errors
  • Code is readable and formatted
  • There isn't any unnecessary commented-out code

Copy link
Collaborator

@aedwardg aedwardg left a comment

Choose a reason for hiding this comment

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

Other than where the Staff type is located, this looks good code-wise.

My only hesitation is whether this is the direction we want to go with the About Page.
In the past (under the CC name) we tried to do a similar "image & bio" approach for server staff and it was very difficult to get the staff to open PRs with their info (or provide it to us so we could open the PR).

That said, I'm open to trying it again.
We could maybe start with only Admins and then ping the rest of the staff and tell them if they want to be included they need to open a PR.

src/types.d.ts Outdated
Copy link
Collaborator

Choose a reason for hiding this comment

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

This should probably just go in the StaffCard component file.
.d.ts files are typically reserved for type declarations from libraries and you almost never need to create them yourself, as most libraries have types on the DefinitelyTyped repo.
You'd only create your own if DefinitelyTyped doesn't have the types you need for a library you're using.
See Typescript handbook here

Copy link
Contributor Author

Choose a reason for hiding this comment

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

So in this instance, would you like to leave the .d.ts file? I'll migrate the Staff type to the StaffCard component either way.

Copy link
Collaborator

Choose a reason for hiding this comment

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

No, let's get rid of the .d.ts file, we shouldn't need one for this project.

Copy link
Collaborator

@aedwardg aedwardg left a comment

Choose a reason for hiding this comment

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

Let's go with this and if we wanna change it up later we can. Nice work!

@Cykotech Cykotech merged commit d8f91f4 into main Feb 16, 2025
3 checks passed
@Cykotech Cykotech deleted the create-about-page branch February 16, 2025 07:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Build initial "About" page
2 participants