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

Migrating docs from wiki #107

Merged
merged 5 commits into from
Aug 19, 2024
Merged

Migrating docs from wiki #107

merged 5 commits into from
Aug 19, 2024

Conversation

dusk125
Copy link
Contributor

@dusk125 dusk125 commented Aug 18, 2024

Addresses #104

@dusk125 dusk125 requested a review from a team August 18, 2024 02:18
@dusk125
Copy link
Contributor Author

dusk125 commented Aug 18, 2024

Need to fix images

Copy link
Contributor

@bhperry bhperry left a comment

Choose a reason for hiding this comment

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

Looking good!

Other suggestions:

  • Change Home.md to README.md so that it auto-renders from the docs folder
  • Update root README.md links to docs instead of wiki

@dusk125
Copy link
Contributor Author

dusk125 commented Aug 18, 2024

While I'm working on fixing the images and adding your suggestions I do have a concern...

The docs add a bunch of images that are going to get cloned down to work on pixel... I don't think go will download them since they're not in a go package

@bhperry
Copy link
Contributor

bhperry commented Aug 18, 2024

hmmmmm.... good point. Not terribly worried about it in terms of git clone time. Having go fetch them would be a bit strange. Should be relatively easy to validate that right?

@bhperry
Copy link
Contributor

bhperry commented Aug 18, 2024

Looks like it didn't download the images, just the markdown

bhperry@DESKTOP-8M5PS14:~/workspace/pixtest$ go mod download github.com/dusk125/pixel/v2@migrate-docs
bhperry@DESKTOP-8M5PS14:~/workspace/pixtest$ ls /home/bhperry/go/pkg/mod/github.com/dusk125/pixel/v2@v2.0.0-20240818024155-23bff67f13dd/docs/
Basics  Compilation  README.md

@dusk125
Copy link
Contributor Author

dusk125 commented Aug 18, 2024

Awesome! Thanks for validating that

Copy link
Contributor

@bhperry bhperry left a comment

Choose a reason for hiding this comment

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

LGTM

@dusk125 dusk125 merged commit 5fa5c6a into gopxl:main Aug 19, 2024
1 check passed
@dusk125 dusk125 deleted the migrate-docs branch August 19, 2024 03:00
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