-
Notifications
You must be signed in to change notification settings - Fork 0
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 documentation #4
Conversation
docs/getting-started.md
Outdated
|
||
### Example Messages | ||
|
||
CONFIGS PLACEHOLDER |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Write some example messages for your app here or accept this suggested change.
CONFIGS PLACEHOLDER | |
Welcome to our repository! Thanks for adding an issue, if you are reporting a bug or a feature request, please make sure to assign a label to this issue. |
Step 5: Merge the user documentationThis Getting Started guide is going to be a great resource for new users. Let's go ahead and merge it - we can always iterate. ⌨️ Activity: Approve the pull request
You can also approve by clicking on Files changed, clicking on Review changes, selecting Approve and then Submit review. I'll respond when you've approved this pull request. |
You have been a huge help to Mona in preparing the repository for new users. Next, let's shift our focus to Mona's future contributors. Mona has been busy putting some thoughts together and is ready for your eyes. 👀 Check out the next issue. |
Step 4: Create user documentation
Well written user documentation is the key to a great user experience. Experts say, "if a user can't figure out how to use your project in less than an hour, they will move on." It pays to attract a few technical writers to your project. 😉
Where to create your documentation
Where to create documentation
Your user documentation should be easy for your users to find. Some prefer to keep it on an externally facing website while others will use a docs folder in their project or the repository wiki.
Getting organized
As an open source project becomes more popular and more sophisticated, some maintainers find it is easier to move their open source project into an a GitHub organization. This allows you to create separate repositories for your project's promotional website, documentation, source code, etc.
What to include
Documentation needs for open source projects will vary, but at a minimum you should include:
Will you help Mona ensure the documentation covers these minimum topics?
⌨️ Activity: Creating user documentation
You can follow the manual steps below, or accept the suggested change in the following comment.
docs/getting-started.md
on this branch, or manually edit it in the Files Changed tab.docs/getting-started.md
file, scroll down and click the Commit changes button.I'll respond when I detect a commit on this branch.