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

feat: add landing page for documentation website #3

Merged
merged 4 commits into from
Jul 25, 2024

Conversation

NucciTheBoss
Copy link
Member

This PR adds a landing page for the Charmed HPC documentation website. This PR adds:

  1. A navbar to different sections such as Tutorials, How-to guides, and Reference
  2. Diátaxis layout for "In this documentation"
  3. Project and community information for Charmed HPC + Ubuntu High-Performance Computing.

Landing page preview

image

- Ignore linkcheck for matrix.to. Cannot resolve the target to Ubuntu HPC space.
- Enable Canonical-specific Sphinx extensions for rendering documentation.
- Ignore README.md and CONTRIBUTING.md for various checks.

Signed-off-by: Jason C. Nucciarone <[email protected]>
Signed-off-by: Jason C. Nucciarone <[email protected]>
Copy link
Contributor

@jedel1043 jedel1043 left a comment

Choose a reason for hiding this comment

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

Nice landing page! Looks great, and should be a nice starting point for our documentation.

@NucciTheBoss NucciTheBoss merged commit a616f38 into charmed-hpc:main Jul 25, 2024
1 check passed
@NucciTheBoss NucciTheBoss deleted the add-landing-page branch July 29, 2024 20:07
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.

2 participants