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

Document TimesliceRobot template #2752

Merged
merged 3 commits into from
Oct 6, 2024

Conversation

leongmichael
Copy link
Contributor

resolve #1446

@leongmichael
Copy link
Contributor Author

leongmichael commented Sep 19, 2024

i realize there are various other templates not documented. would it be best to merge this first or do them all in this one PR?

@jasondaming
Copy link
Member

Looks like you have an annoying extra whitespace linting error probably just a space at the end of a line or on a blank line.

I would say it is up to you on the organization of this vs multiple PRs. I think the only two template types that aren't documented are "skeletons" and "educational". Skeletons could be generically mentioned in one paragraph towards the beginning. Educational has a very narrow specific use case that I'm not sure it would be worth documenting here.

If you are looking for additional ideas for improving this document the 2 highest on my list would be:

  1. Advice up front about making (or not making) a selection. This is always difficult to do impartially but is often the most critical piece for helping teams. In this case what I would stress is that starting from a template is IMO a really bad idea for a new user. It leaves them with a lot of blank page fears and gives them little (other than the template comments) to guide them on the proper structure. Instead new teams should be looking at an understanding the example most relevant to them and/or past team code with goals similar to theirs. I think it would also be good to link to "What is Command Based" instead of referencing a tutuorial that no longer exists and linking to the index page.
  2. Adding Python. It has been a slow process for us to get Python added everywhere but we should do our best to link to it also in all situations where it has the same features and Java/C++ are explicitly linked.

@sciencewhiz sciencewhiz merged commit b0944a3 into wpilibsuite:main Oct 6, 2024
10 checks passed
@leongmichael leongmichael deleted the timeslicerobot branch October 6, 2024 21: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.

Document TimesliceRobot template
3 participants