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

refactor site #18

Merged
merged 1 commit into from
Aug 11, 2024
Merged

refactor site #18

merged 1 commit into from
Aug 11, 2024

Conversation

NKeleher
Copy link
Collaborator

Pull Request Summary 🚀

What does this PR do? 📝

Fix github action and refactor site structure

Why is this change needed? 🤔

GitHub Action was failing and we need to refactor the website for easier document structure.

How was this implemented? 🛠️

I ran just build-docs and preview the site using just preview-docs

How to test or reproduce ? 🧪

Screenshots (if applicable) 📷

Checklist ✅

  • I have run and tested my changes locally
  • I have limit this PR to less than 1000 lines of code change (if not, explain why)
  • I have updated/added tests to cover my changes (if applicable)
  • I have updated/added requirements to cover my changes (if applicable)
  • I have run linting and formatting on any code changes (if applicable)
  • I have updated the documentation (README, etc.) accordingly
  • I have reviewed and resolved any merge conflict

Reviewer Emoji Legend

:code: Meaning
😃👍💯 :smiley: :+1: :100: I like this...

...and I want the author to know it! This is a way to highlight positive parts of a code review.
⭐⭐⭐ :star: :star: :star: Important to fix before PR can be approved...

And I am providing reasons why it needs to be addressed as well as suggested improvements.
⭐⭐ :star: :star: Important to fix but non-blocking for PR approval...

And I am providing suggestions where it could be improved either in this PR or later.
:star: Give this some thought but non-blocking for PR approval...

...and consider this a suggestion, not a requirement.
:question: I have a question.

This should be a fully formed question with sufficient information and context that requires a response.
📝 :memo: This is an explanatory note, fun fact, or relevant commentary that does not require any action.
:pick: This is a nitpick.

This does not require any changes and is often better left unsaid. This may include stylistic, formatting, or organization suggestions and should likely be prevented/enforced by linting if they really matter
♻️ :recycle: Suggestion for refactoring.

Should include enough context to be actionable and not be considered a nitpick.

@NKeleher NKeleher requested a review from a team as a code owner August 11, 2024 21:52
@NKeleher NKeleher merged commit f1649a1 into main Aug 11, 2024
1 check passed
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.

1 participant