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

Broadly deformalize and streamline documentation #1678

Open
2 tasks
micahellison opened this issue Feb 11, 2023 · 0 comments
Open
2 tasks

Broadly deformalize and streamline documentation #1678

micahellison opened this issue Feb 11, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation 📌 This can't go stale
Milestone

Comments

@micahellison
Copy link
Member

Affected Page(s)

Take a pass through all the docs

What Could Be Better?

We try to keep the docs relatively informal and direct in second person: "You can do this" instead of longer, less personal sentences like "This can be achieved by doing this." We want to keep that informal style in the user guide section, but we've still merged in PRs with good information that don't match that tone because we don't want to hold up good info with tons of labor to rewrite.

  • Review all the docs for impersonal, passive sentences and make them more direct and informal
  • Review the contributing guide - did we mention using this tone? Could we be more clear about it?

Other Information

Maybe this becomes an annual process for us, like the dependency audit.

@micahellison micahellison added documentation Improvements or additions to documentation 🆕 New! 📌 This can't go stale and removed 🆕 New! labels Feb 11, 2023
@wren wren added this to the Backlog milestone Feb 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation 📌 This can't go stale
Projects
None yet
Development

No branches or pull requests

2 participants