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

docs: Add initial uVisor Onboarding Guide #409

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Patater
Copy link
Contributor

@Patater Patater commented Feb 14, 2017

@AlessandroA
Copy link
Contributor

As this document will likely grow a lot in the future, I think we should stay away from colloquial sentences and stick to concise bullet points.

As for the structure, a long time ago we moved away from 80-col files for markdown because of a requirement from the docs team (apparently it was not rendered well or something like that). Now all of our docs are unwrapped. I prefer the 80-col limit much more, but it would now break consistency. What do you think? @Patater

@Patater
Copy link
Contributor Author

Patater commented Feb 15, 2017

Consise bullet points are boring. We've got to have some style in our voice. The onboarding guide isn't really meant to be overall technical, and certainly the introduction needs to be informal and fun. There are technical portions, and where it is technical, we already do use bullet points where it makes sense to do so.

This wasn't written to be processed by the docs team, but for easy reading and editing among ourselves. If we do want it to be processed by the docs team at some point, we should file an issue to fix the 80 columns problem. It's so much easier to edit with the 80 column limit.

@AlessandroA
Copy link
Contributor

retest uvisor

@AnotherButler
Copy link
Contributor

@Patater Is this an internal document for our team to use, or is this technical documentation for contributors?

@Patater
Copy link
Contributor Author

Patater commented Sep 21, 2017

@AnotherButler This is somewhat technical (although not "tech writing") documentation for all contributors. We keep internal documents internal.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants