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

Add When to use it / When not to use it sections #285

Open
wooorm opened this issue Jun 19, 2020 · 0 comments
Open

Add When to use it / When not to use it sections #285

wooorm opened this issue Jun 19, 2020 · 0 comments
Labels
📚 area/docs This affects documentation help wanted 🙏 This could use your insight or help 🙆 status/confirmed This is open and confirmed: ready to be worked on 🦋 type/enhancement This is great to have

Comments

@wooorm
Copy link
Member

wooorm commented Jun 19, 2020

Subject of the feature

A section in the readme and on the website that lists where using alex does and doesn’t make sense

Problem

As this is lacking, folks stumbling on alex assume that it does wildly different things.

Expected behaviour

It should be clarified that alex was made for technical docs, theses, etc.: text that shouldn’t assume context. Not for fiction or when texting your partner or so.

Alternatives

n/a

@wooorm wooorm added 📚 area/docs This affects documentation 🙆 status/confirmed This is open and confirmed: ready to be worked on 🦋 type/enhancement This is great to have help wanted 🙏 This could use your insight or help labels Jun 19, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 area/docs This affects documentation help wanted 🙏 This could use your insight or help 🙆 status/confirmed This is open and confirmed: ready to be worked on 🦋 type/enhancement This is great to have
Development

No branches or pull requests

1 participant