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

reorganize chapters: add technology guides section #340

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

egpbos
Copy link
Member

@egpbos egpbos commented Sep 25, 2024

Changes in this PR

This PR adds the new section of technology guides and moves the GPU and UX chapters there.

Also moved language guides to the root folder level, because I find it annoying to have to click into the best_practices folder.

Note: datasets still has to be moved to technologies, but there is an outstanding PR #339 on that and I don't want to stress git's ability to detect moved files too much, otherwise we lose the ability to easily browse edit history.

Fixes #335.

@egpbos egpbos marked this pull request as draft September 25, 2024 15:02
@bouweandela
Copy link
Member

@egpbos You've requested our review, but it is still in draft. Would you like me to review this now?

@egpbos
Copy link
Member Author

egpbos commented Sep 26, 2024

Yes, you can review. The only thing that I still want to do before merging is move the dataset chapter as well, after #339 is merged, that's why it's still in draft.

Copy link
Member

@bouweandela bouweandela left a comment

Choose a reason for hiding this comment

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

Would it make sense to move the language and technology guides above the best practices (which we're planning to delete anyway) in the sidebar?

The README.md still needs to be updated to reflect the changes here.

@egpbos
Copy link
Member Author

egpbos commented Sep 26, 2024

Good catch, updated the README.

I would suggest to consider the Best Practices in another thread, because I'm not sure if we should completely remove it.

@egpbos
Copy link
Member Author

egpbos commented Sep 26, 2024

Ah, we had that other thread already :P #321

Also moved language guides to the root folder level, because I find it annoying to have to click into the best_practices folder.

Note: datasets still has to be moved to technologies, but there is an outstanding PR on that and I don't want to stress git's ability to detect moved files too much, otherwise we lose the ability to easily browse edit history.
@egpbos
Copy link
Member Author

egpbos commented Sep 27, 2024

Ok, I moved it down as you suggested after all. Otherwise the technology menu is too far down and it may not be noticed.

@egpbos egpbos marked this pull request as ready for review September 27, 2024 19:54
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.

Add tech chapters section
2 participants