Add documentation #4
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![github-learning-lab[bot]](https://avatars.githubusercontent.com/in/10572?s=60&v=4){kind=small}
docs/getting-started.md
Outdated
|
|
||
| ### Example Messages | ||
|
|
||
| CONFIGS PLACEHOLDER |
There was a problem hiding this comment.
Write some example messages for your app here or accept this suggested change.
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. |
Merged
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. |
kirillperesh
approved these changes
Jan 14, 2021
|
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. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.mdon this branch, or manually edit it in the Files Changed tab.docs/getting-started.mdfile, scroll down and click the Commit changes button.I'll respond when I detect a commit on this branch.