Creating Documentation Files from Scratch - treenabalds/How-To GitHub Wiki

Do I follow the same procedure as creating README files to create other types of text files for documentation purposes?

Absolutely! The process for creating other types of text files for documentation—such as CONTRIBUTING.md, LICENSE.md, or custom documentation like GUIDE.txt or NOTES.md—is quite similar to creating a README file. Here’s a quick guide:

  1. Choose Your File Type:

    • Decide on the file format based on your needs:
      • Use .md (Markdown) for formatted text with headings, links, and styling.
      • Use .txt for plain text without formatting.

  2. Create the File Locally:

    • Open your local repository folder.
    • Use any text editor (like Notepad or VS Code) to create the file.
    • Save it with a descriptive name, like CONTRIBUTING.md or CHANGELOG.txt.

  3. Add Content:

    • Write the necessary content, such as instructions for contributing, a license description, or documentation relevant to your project.

  4. Stage the Changes:

    • Open the GitHub Desktop app.
    • The new file will appear as an uncommitted change. Verify that the changes are listed correctly.

  5. Commit and Push:

    • Add a commit message (e.g., “Added CONTRIBUTING guidelines” or “Updated CHANGELOG”).
    • Commit the file and push the changes to the repository on GitHub.

If you're doing this directly on GitHub through the browser, the steps mirror the README creation process: select “Create new file,” name it appropriately, add your content, and commit it.

Let me know if you'd like help structuring one of these documentation files! Each has its own best practices.