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

Document intentional design choices where different from webapp/mobile #547

Closed
neiljp opened this issue Mar 17, 2020 · 1 comment · Fixed by #1224
Closed

Document intentional design choices where different from webapp/mobile #547

neiljp opened this issue Mar 17, 2020 · 1 comment · Fixed by #1224
Labels
area: documentation Requires changes in documentation difficult high priority should be done as soon as possible
Milestone

Comments

@neiljp
Copy link
Collaborator

neiljp commented Mar 17, 2020

This issue has some overlaps with the idea of having tutorials or extra documentation along these lines, but my thought for this issue would be a small section in the README indicating eg. how ZT is keyboard driven and only incidentally mouse-accessible (for now), and other related design choices/constraints.

Most aspects of ZT have tried to remain similar to the webapp, but it would similarly be useful to document specific cases where we are not compatible, or have extensions which are different/interesting (eg. z key)

This could also be an area where we list known limitations, whether inherent to the platform (ie. images) or where we don't yet support certain features or ranges of features, and potentially the priority we ascribe to adding them right now. This potentially has overlap with just tracking with issues, but would probably be broader unsupported areas, eg. admin or options.

@neiljp neiljp added the area: documentation Requires changes in documentation label Mar 17, 2020
@neiljp neiljp changed the title User documentation in README for migration/differences from webapp Document intentional design choices where different from webapp/mobile Jan 19, 2021
@neiljp
Copy link
Collaborator Author

neiljp commented Jan 19, 2021

I've updated this issue title to narrow the scope slightly.

Listing known limitations probably belong with #731, though longer-term aspects are now part of https://github.com/zulip/zulip-terminal#about

When we add the details of intentional differences, which could perhaps go into a separate file in docs/, we can also consider relating these to a FAQ entry named something like "Migrating from the webapp (or other Zulip interfaces)" - or this could even be in the README.

Note that as briefly discussed in #26, this covers intentional differences and those imposed through platform requirements.

@neiljp neiljp added this to the Next Release milestone Jan 31, 2021
@neiljp neiljp added difficult high priority should be done as soon as possible labels Aug 17, 2021
neiljp added a commit to neiljp/zulip-terminal that referenced this issue May 16, 2022
neiljp added a commit to neiljp/zulip-terminal that referenced this issue May 16, 2022
neiljp added a commit to neiljp/zulip-terminal that referenced this issue May 16, 2022
neiljp added a commit to neiljp/zulip-terminal that referenced this issue May 16, 2022
neiljp added a commit to neiljp/zulip-terminal that referenced this issue May 16, 2022
neiljp added a commit to neiljp/zulip-terminal that referenced this issue May 16, 2022
neiljp added a commit to neiljp/zulip-terminal that referenced this issue May 16, 2022
neiljp added a commit to neiljp/zulip-terminal that referenced this issue May 16, 2022
neiljp added a commit to neiljp/zulip-terminal that referenced this issue May 16, 2022
neiljp added a commit to neiljp/zulip-terminal that referenced this issue May 16, 2022
neiljp added a commit to neiljp/zulip-terminal that referenced this issue May 16, 2022
neiljp added a commit to neiljp/zulip-terminal that referenced this issue May 16, 2022
neiljp added a commit to neiljp/zulip-terminal that referenced this issue May 16, 2022
neiljp added a commit to neiljp/zulip-terminal that referenced this issue May 16, 2022
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 difficult high priority should be done as soon as possible
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant