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

Restructure pages and chapters #61

Merged
merged 8 commits into from Jul 25, 2020
Merged

Restructure pages and chapters #61

merged 8 commits into from Jul 25, 2020

Conversation

ysims
Copy link
Member

@ysims ysims commented Jul 9, 2020

System->NUbots has been split into

  • System->Foundations: foundational aspects of the main codebase eg NUClear, maths, build system
  • System->Subsystems: subsystems within the modules folder such as vision, motion, odometry

System->NUsight and System->Other Project has been combined into

  • System->Tools: contains any tools outside of the main codebase such as NUsight, NUpbr, NUbook

Guides -> (various) -> Troubleshooting and Guides->NUbots->Glossary have been put into a new chapter

  • Guides->General: any general information such as troubleshooting, glossary, git guide

Guides->NUsight and Guides->Other have been combined similarly to the System section

  • Guides->Tools: guides for any NUbots tools such as NUsight

PREVIEW

@ysims
Copy link
Member Author

ysims commented Jul 9, 2020

I would like to rename Guides->NUbots but not sure what to change it to.

@JosephusPaye
Copy link
Member

I like the restructure 👍. Now I'm considering:

  • Renaming "The NUbots Team" to "Team"
  • Renaming "Foundations" to "Foundation"

I think Guides → NUbots is OK.

@ysims
Copy link
Member Author

ysims commented Jul 9, 2020

I like the restructure 👍. Now I'm considering:

  • Renaming "The NUbots Team" to "Team"
  • Renaming "Foundations" to "Foundation"

I think Guides → NUbots is OK.

Yes I was tossing up between Foundations, Foundation, Foundational... I'm still not sure.

I think "The Team" would be better than "Team". But I like "The NUbots Team".

I am unsure about "Guides → NUbots" because all the guides are NUbots guides. "Main Codebase" would be maybe better but it's longish.

@ysims
Copy link
Member Author

ysims commented Jul 17, 2020

Upon further consideration, Team does fit in better with System and Guides.

@CMurtagh-LGTM
Copy link
Contributor

We have a troubleshooting page, should this just be one page or broken down into General, Codebase, NUsight, Hardware, NUbook, etc.?

@ysims
Copy link
Member Author

ysims commented Jul 18, 2020

We have a troubleshooting page, should this just be one page or broken down into General, Codebase, NUsight, Hardware, NUbook, etc.?

It was broken down before, but it felt a little... scattered. I prefer the one page. What do you all think?

@CMurtagh-LGTM
Copy link
Contributor

I suppose it depends on how much content is in each troubleshooting section.

Copy link
Collaborator

@Bidski Bidski left a comment

Choose a reason for hiding this comment

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

Seems ok

@ysims ysims merged commit 6d076f6 into master Jul 25, 2020
@ysims ysims deleted the sims/restructure branch July 25, 2020 00:26
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.

None yet

4 participants