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.

Sign up for GitHub

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

Jump to bottom

General getting started documentation #173

Merged
merged 8 commits into from
Feb 1, 2024
Merged

General getting started documentation #173

merged 8 commits into from
Feb 1, 2024

Conversation

jacobkoziej
Copy link
Member

The following adds a general getting started guide for the repository.

@jacobkoziej jacobkoziej added the documentation Improvements or additions to documentation label Jan 30, 2024
@jacobkoziej jacobkoziej self-assigned this Jan 30, 2024
ajaku
ajaku previously approved these changes Jan 31, 2024
View reviewed changes
Copy link
Contributor

@ajaku ajaku left a comment

Choose a reason for hiding this comment

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

It looks really good! Just one thing, when you mention /docs and the symlinks I'd either give a brief description of what a symlink is or hyper link to some resource describing it.

@jacobkoziej
Copy link
Member Author

It looks really good! Just one thing, when you mention /docs and the symlinks I'd either give a brief description of what a symlink is or hyper link to some resource describing it.

I think that's a good idea. I'll get that added in.

@jacobkoziej jacobkoziej merged commit 56f0a70 into dev Feb 1, 2024
5 checks passed
@jacobkoziej jacobkoziej deleted the users/jacobkoziej/docs/getting-started branch February 1, 2024 21:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ajaku ajaku ajaku approved these changes

@mgiglia92 mgiglia92 Awaiting requested review from mgiglia92

@fred13kim fred13kim Awaiting requested review from fred13kim

@Vaibhav-Hariani Vaibhav-Hariani Awaiting requested review from Vaibhav-Hariani

@giuseppequaratino giuseppequaratino Awaiting requested review from giuseppequaratino

@ilona403 ilona403 Awaiting requested review from ilona403

@Ridwan-Hussain Ridwan-Hussain Awaiting requested review from Ridwan-Hussain

@isaiahrivera21 isaiahrivera21 Awaiting requested review from isaiahrivera21

Assignees

@jacobkoziej jacobkoziej

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jacobkoziej @ajaku