search

Lilmohawk4000 / community-starter-kit

One of many tutoriol repos
https://lab.github.com/githubtraining/community-starter-kit
0 stars 0 forks source link

Add documentation #3

Open github-learning-lab[bot] opened 2 years ago

github-learning-lab[bot] commented 2 years ago

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. :wink:

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?

:keyboard: Activity: Creating user documentation

You can follow the manual steps below, or accept the suggested change in the following comment.

  1. Edit docs/getting-started.md on this branch, or manually edit it in the Files Changed tab.
  2. Find the placeholder text marked CONFIGS PLACEHOLDER.
  3. Replace the placeholder with some example welcome messages that may be helpful to new users.
  4. After editing the docs/getting-started.md file, scroll down and click the Commit changes button.

I'll respond when I detect a commit on this branch.

github-learning-lab[bot] commented 2 years ago

Step 5: Merge the user documentation

This Getting Started guide is going to be a great resource for new users. Let's go ahead and merge it - we can always iterate.

:keyboard: Activity: Approve the pull request

  1. Clicking on this quicklink
  2. Select Approve
  3. Click Submit review.

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.