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

New getting started doc #101

Merged
merged 3 commits into from Mar 13, 2024
Merged

New getting started doc #101

merged 3 commits into from Mar 13, 2024

Conversation

bmicklea
Copy link
Contributor

  • add getting-started.md doc
  • add structure.md doc for Kitfile
  • update readme.md to point to getting started

@bmicklea
new getting started doc
04be1b3 
* add getting started doc
* add structure doc for Kitfile
* update readme to point to getting started
@bmicklea bmicklea requested a review from gorkem March 12, 2024 15:40
@bmicklea bmicklea marked this pull request as draft March 12, 2024 15:40
gorkem
gorkem reviewed Mar 12, 2024
View reviewed changes
docs/src/docs/kitfile/structure.md Outdated
Copy link
Contributor

Choose a reason for hiding this comment

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

Feels like this should be part of the Overview

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, I realized that just now too. Reworked to do that and clean up a few other loose ends (including the nav).

@bmicklea
Rework
96a1caa 
* Moved structure doc into kitfile overview doc
* renamed getting-started.md to quick-start.md
* Updated overview to remove "getting started" header
* Updated  nav to add the quick start
@bmicklea bmicklea self-assigned this Mar 12, 2024
@bmicklea bmicklea marked this pull request as ready for review March 12, 2024 15:47
@bmicklea bmicklea added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 12, 2024
@bmicklea
Final docs tweaks...
7532dda 
...hopefully
@bmicklea bmicklea requested a review from gorkem March 12, 2024 19:59
@bmicklea
Copy link
Contributor Author

Ok, I think these are all the urgent docs tweaks we need for launch.

@bmicklea bmicklea merged commit 266ea7f into main Mar 13, 2024
1 check passed
@bmicklea bmicklea deleted the getting-started branch March 13, 2024 13:25
@bmicklea bmicklea restored the getting-started branch March 14, 2024 15:59
@amisevsk amisevsk deleted the getting-started branch March 19, 2024 17:34
@amisevsk amisevsk restored the getting-started branch March 19, 2024 17:34
@amisevsk amisevsk deleted the getting-started branch April 4, 2024 15:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gorkem gorkem gorkem approved these changes

Assignees

@bmicklea bmicklea

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@bmicklea @gorkem