Skip to content
New issue

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

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

Already on GitHub? # to your account

Docs: Setup Guide Page #213

Merged
merged 2 commits into from
Dec 22, 2024
Merged

Docs: Setup Guide Page #213

merged 2 commits into from
Dec 22, 2024

Conversation

GODrums
Copy link
Collaborator

@GODrums GODrums commented Dec 10, 2024

Motivation

Implements task 1 of #201.

Description

This PR aims to:

  • Add the docs-folder to the project-workspace
  • Create an initial version of the "Setup Guide"-page in the Hephaestus documentation.

Testing Instructions

Run the docs (consult the README.md for more details):

  • pip install -r requirements.txt
  • make livehtml

And navigate to http://0.0.0.0:55862/dev/setup_guide.html.

Checklist

General

  • PR title is clear and descriptive
  • PR description explains the purpose and changes
  • Code follows project coding standards
  • Self-review of the code has been done
  • Changes have been tested locally
  • Screenshots have been attached (if applicable)
  • Documentation has been updated (if applicable)

@GODrums GODrums added the documentation Improvements or additions to documentation label Dec 10, 2024
@GODrums GODrums self-assigned this Dec 10, 2024
@github-actions github-actions bot added feature size:L This PR changes 100-499 lines, ignoring generated files. labels Dec 10, 2024
Copy link
Contributor

@milesha milesha left a comment

Choose a reason for hiding this comment

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

lgtm :)

@GODrums GODrums merged commit 9783fca into develop Dec 22, 2024
3 of 4 checks passed
@GODrums GODrums deleted the feat/docs-setup-guide branch December 22, 2024 12:14
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
documentation Improvements or additions to documentation feature size:L This PR changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants