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

chore: big docs overhaul #451

Merged
merged 5 commits into from
Sep 27, 2023
Merged

chore: big docs overhaul #451

merged 5 commits into from
Sep 27, 2023

Conversation

Gankra
Copy link
Contributor

@Gankra Gankra commented Sep 26, 2023 •
edited
Loading

fixes #432

@Gankra
Copy link
Contributor Author

Gankra commented Sep 26, 2023

image

@Gankra
Copy link
Contributor Author

Gankra commented Sep 26, 2023 •
edited
Loading

NOTE: this is blocked on cutting axolotlsay 0.2.0 with axodotdev/axolotlsay#11, and regenerating some screenshots with it

@Gankra Gankra marked this pull request as draft September 26, 2023 17:36
@Gankra
Copy link
Contributor Author

Gankra commented Sep 26, 2023 •
edited
Loading

NOT REALLY FINISHED/THOUGHT-THROUGH: the "ci" section (index is misty's thing verbatim rn)

@Gankra
Copy link
Contributor Author

Gankra commented Sep 26, 2023 •
edited
Loading

HALF-BAKED: I started rebranding "executable-zip" as "archive" but haven't done all the changes

mistydemeo
mistydemeo reviewed Sep 26, 2023
View reviewed changes
Copy link
Contributor

@mistydemeo mistydemeo left a comment

Choose a reason for hiding this comment

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

Generally, I'm feeling happy about this - I think it's a much nicer organization than we had before. I do feel like we need to make the README and the intro section of the book more distinct from each other than they are in this version. The README is introducing details that are irrelevant to a lot of people landing on our landing page or the repo, but which make sense to people reading the book.

@Gankra Gankra added this to the 0.3.0 milestone Sep 26, 2023
@Gankra Gankra marked this pull request as ready for review September 26, 2023 22:08
shadows-withal
shadows-withal approved these changes Sep 27, 2023
View reviewed changes
Copy link
Contributor

@shadows-withal shadows-withal left a comment

Choose a reason for hiding this comment

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

amazing work!!!

@Gankra Gankra merged commit e6b2b04 into main Sep 27, 2023
@Gankra Gankra deleted the docs-overhaul branch September 27, 2023 12:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mistydemeo mistydemeo mistydemeo approved these changes

@shadows-withal shadows-withal shadows-withal approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
0.3.0
Development

Successfully merging this pull request may close these issues.

write msi docs
3 participants
@Gankra @mistydemeo @shadows-withal