Using and Generating Documentation

Esta página introduce la formación mínima de GitHub para escribir documentación, descargarla, sincronizar y trabajar en colaborativo con el resto de desarrolladores.

GitBook tip: your product docs aren't just a reference of all your features! use them to encourage folks to perform certain actions and discover the.

• Step 1: Introduction to Github Make a new public repository with a name that matches your GitHub username. Create a file named README.md in its root. The "root" means not inside any folder in your repository. Edit the contents of the README.md file. If you created a new branch for your file, open and merge a pull request on your branch.

• Step 2: Communicate using Markdowns You learned about Markdown, headings, images, code examples, and task lists. You created and merged a Markdown file.

Customize

Managing labels: About milestones: About wikis:

• Step 3: Github Pages You enabled GitHub Pages. You selected a theme using the config file. You learned about proper directory format and file naming conventions in Jekyll. You created your first a blog post with Jekyll!

• Step 4: Review Pull Request You learned how to assign pull requests for review. You left a review on a pull request. You suggested changes to a pull request. You applied suggested changes to a pull request.

• Step 5: Resolve merge conflicts You learned why merge conflicts happen. You resolved a simple merge conflict. You created a merge conflict, and resolved it!

Further resources

• Step 6: Realease-based workflow Create a beta release. Add a new feature to the release branche. Open a release pull request Automate release notes. Merge and finalize the release branch. Commit a hotfix to the release. Create release v1.0.1.

• Step 7: Connect the dots

• Step 8: Github Actions

• Step 9: Continuous integration

• Webhooks Webhooks provide a way for notifications to be delivered to an external web server whenever certain actions occur on a repository or organization.documentation

how to write documentatiion: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax advance formating: https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams github: https://skills.github.com/ webhooks: https://docs.github.com/en/get-started/customizing-your-github-workflow/exploring-integrations/about-webhooks

Managing labels: https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/managing-labels About milestones: https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/about-milestones About wikis: https://docs.github.com/en/communities/documenting-your-project-with-wikis/about-wikis