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

Mkdocs added to /docs resolves #334 #345

Merged
merged 10 commits into from
Sep 19, 2024
Merged

Mkdocs added to /docs resolves #334 #345

merged 10 commits into from
Sep 19, 2024

Conversation

p5ntangle
Copy link
Contributor

Adding Mkdocs and the basic initial setup to the docs repo.

@Schnitzel Schnitzel self-assigned this Sep 18, 2024
@Schnitzel Schnitzel self-requested a review September 18, 2024 16:55
Schnitzel
Schnitzel previously approved these changes Sep 18, 2024
Copy link
Contributor

@Schnitzel Schnitzel left a comment

Choose a reason for hiding this comment

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

tested the mk-docs setup on what is defined in docs/mk-docs-setup.md and was able to get it running on my local notebook

@Schnitzel Schnitzel removed their assignment Sep 18, 2024
docs/introduction.md Outdated Show resolved Hide resolved
docs/introduction.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/mk-docs-setup.md Outdated Show resolved Hide resolved
docs/mk-docs-setup.md Show resolved Hide resolved
mkdocs.yml Outdated Show resolved Hide resolved
Co-authored-by: Kyle Squizzato <[email protected]>
Signed-off-by: Michael Schmid <[email protected]>
Copy link
Collaborator

@a13x5 a13x5 left a comment

Choose a reason for hiding this comment

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

Some minor notes on formating + possibly missing content.

docs/mk-docs-setup.md Show resolved Hide resolved
docs/quick-start.md Outdated Show resolved Hide resolved
docs/quick-start.md Outdated Show resolved Hide resolved
docs/stylesheets/extra.css Outdated Show resolved Hide resolved
mkdocs.yml Show resolved Hide resolved
docs/quick-start.md Outdated Show resolved Hide resolved
@Schnitzel
Copy link
Contributor

@PrashantR30 can I hand over working on these review suggestions to you? I don't think @p5ntangle or myself will have time to work on this - thanks!

@PrashantR30
Copy link

@PrashantR30 can I hand over working on these review suggestions to you? I don't think @p5ntangle or myself will have time to work on this - thanks!

Sure @Schnitzel

p5ntangle and others added 2 commits September 19, 2024 10:37
Co-authored-by: Kyle Squizzato <[email protected]>
Signed-off-by: Shaun O'Meara <[email protected]>
@p5ntangle p5ntangle requested a review from a13x5 September 19, 2024 17:54
@p5ntangle
Copy link
Contributor Author

@PrashantR30 I have made the changes suggested by @a13x5.

Copy link
Collaborator

@a13x5 a13x5 left a comment

Choose a reason for hiding this comment

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

I see all suggestions were added, so all looks good

@a13x5 a13x5 merged commit 13b5245 into k0rdent:main Sep 19, 2024
3 checks passed
@p5ntangle p5ntangle deleted the hmc-334 branch September 19, 2024 19:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

6 participants