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

docs: add docs folder and Quick Start guide #161

Merged
merged 5 commits into from
Jan 30, 2025

Conversation

nanderstabel
Copy link
Collaborator

@nanderstabel nanderstabel commented Jan 17, 2025

Description of change

Added a docs folder that we can use to store our documentation 'source' files. For now it only contains a quick-start.md file but in the future more documentation files will be added here.

Links to any relevant issues

See the corresponding /docs PR: https://github.com/impierce/docs/pull/6
and the actual documentation preview: https://docs-git-test-quick-start-impierce.vercel.app/unicore/introduction/quick-start

How the change has been tested

n/a

Definition of Done checklist

Add an x to the boxes that are relevant to your changes.

  • I have followed the contribution guidelines for this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have successfully tested this change in a docker environment

@nanderstabel nanderstabel self-assigned this Jan 17, 2025
@nanderstabel nanderstabel added the Documentation Improvements or additions to documentation label Jan 17, 2025
@nanderstabel nanderstabel marked this pull request as ready for review January 17, 2025 11:35
docs/introduction/quick-start.md Outdated Show resolved Hide resolved
docs/introduction/quick-start.md Outdated Show resolved Hide resolved
docs/introduction/quick-start.md Outdated Show resolved Hide resolved
docs/introduction/quick-start.md Show resolved Hide resolved
@nanderstabel nanderstabel merged commit a220657 into beta Jan 30, 2025
2 checks passed
@nanderstabel nanderstabel deleted the docs/quick-start-guide branch January 30, 2025 11:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements or additions to documentation
Projects
Development

Successfully merging this pull request may close these issues.

2 participants