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 list of caveats for incomplete/absent features #731

Open
neiljp opened this issue Jul 22, 2020 · 1 comment
Open

Add list of caveats for incomplete/absent features #731

neiljp opened this issue Jul 22, 2020 · 1 comment
Labels
area: documentation Requires changes in documentation further discussion required Discuss this on #zulip-terminal on chat.zulip.org high priority should be done as soon as possible
Milestone

Comments

@neiljp
Copy link
Collaborator

neiljp commented Jul 22, 2020

The client works rather well at this point, but it's important for prospective users to know whether features are present, hidden/undocumented/difficult-to-find, partially implemented, not implemented. These could refer to issues/PRs, and be put in various categories.

This probably belongs in the FAQ, though perhaps is significant enough to sit in a separate document. This may be too large to fit reasonably in the README, where I've seen it in other projects.

This was previously discussed in #zulip-terminal>launch checklist on chat.zulip.org.

@neiljp neiljp added further discussion required Discuss this on #zulip-terminal on chat.zulip.org area: documentation Requires changes in documentation labels Jul 22, 2020
@preetmishra
Copy link
Member

I am inclined towards a separate document that we could link to FAQ.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation Requires changes in documentation further discussion required Discuss this on #zulip-terminal on chat.zulip.org high priority should be done as soon as possible
Projects
None yet
Development

No branches or pull requests

2 participants