tabaddor / av-swe-guide Goto Github PK

For the Table of Contents section of the README, make sure each part links to the appropriate section in the README.

For all links that link to EXTERNAL sites or pages (not part of the repository), add the following:

[link](url){:target="_blank"}

A note: This may not actually work, and may just render the {"target="_blank"} as text. If that is the case, use an anchor tag, but make sure the text ui looks the same as before.

For images embedded in markdown (README.md, contributing.md), make sure that the images alt text describes what the image is, and fix any unspecified or too general alt texts.

Something to consider for the future with more content and contributors.

Staying organized will be important for this project, and having monthly iterations and milestones will be helpful gauge on progress and organization.

Write the ROS documentation for the tutorial. Skeleton documenation should already be up.

This is based on Michigan Autonomous Aerial Vehicle's ROS Tutorial. Credit will be given.

Maybe re-purpose, or provide link to their ROS tutorial.

Source: https://github.com/tabaddor/av-swe-guide#getting-started-w-the-guide-tada

For Introduction: provide overall description of the project

For Navigating: describe how to navigate the repo with gif or picture examples,

For Sections: explain how the individual sections contribute to the project as a whole

For Tutorials: explain basic tutorial usage for each

For Community: explain basic community guidelines

The basic outline is mostly done, but fill in the respective sections with relevant, interesting information and resources as it pertains to software engineering.

Currently, there is one main document (README.md) where all the information for each section is written up. Separating each section into its own .md file (i.e, PERCEPTION.md) and simply linking it from the main README will improve user experience.

The style guide can be found here in the contributing docs.

Write a style guide that touches upon:
1. Proper Grammar and Punctuation

This will be updated when I decide proper style.

For efficiency, instead of re-creating tutorials (ML, gazebo simulator, etc), find reputable, popular tutorials and provide links and setup resources for users to get started on those.

This issue will always be "open."

Feel free to submit a pull request that fixes any typos in documentation in this project repository, and reference this issue.

Some questions to answer (more will be added):

1. Who can use this guide?

2. How do I get started with this guide/roadmap?

3. Can I download this project?

4. How do I contribute to this project?

Format in the following manner:

Q: This is a question?
A: I guess this is an answer.

Add some relevant, non-technical summary, papers, info, diagrams, pictures, etc to the sections. Though make sure they are specific to the topic of the section.

For example, within Deep Learning, include links to an neural network simulator, how a neural network was inspired by the biological mechanism, etc.

Source: https://github.com/tabaddor/av-swe-guide#av-companies-briefcase

For each company, provide relevant links and information including, but not limited to:
1. Open internship and full-time positions
2. Research reports, initiatives, etc
3. Relevant company news
4. Company product descriptions and links

Remember, we want to keep the user interface clean and accessible for GitHub users on all devices.

NOTE: This issue will always be "open" as relevant information and positions for companies will always be updating. That said, continuous contributions are always welcome. Be sure to first read the contribution guidelines if this is your first contribution.

Thanks!