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

Get started docs - markdown file #84

Open
wants to merge 16 commits into
base: main
Choose a base branch
from
Open

Conversation

chryzcode
Copy link
Contributor

No description provided.

Copy link
Contributor

@mikenrowland mikenrowland left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well done @chryzcodez nice job. Here is a quick review:

  1. There are some few issues with consistency in write up tone and text format e.g. ending some questions with a full stop, typographical errors (e.g. 'organizationations'), the tone also sounds like you came up with the whole write up out of the top of your head etc.
    For the tone, I recommend you liaise with VMS department, their write ups will help you word the introductory parts of this doc properly.

  2. Under the heading 'zurichat plugins', seems like you've mixed up a few things:

  • Zuri main, Zuri API, Zuri desktop and mobile are not plugins
  • Replace this heading with a more appropriate one that encapsulates all the functionalities
  • Zuri main and API can be categorized as 'ZuriChat Control' under the new heading, while the desktop and mobile categorized as 'ZuriChat Apps', and the plugins as 'ZuriChat Plugins'
  1. Also the bulleting format is inconsistent and one can hardly differentiate a subheading from a bullet point under some of the plugins

Please kindly make changes and update accordingly.
Thanks and kind regards.

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

Successfully merging this pull request may close these issues.

2 participants