GitAuto: [FEATURE] Add docs

[gitauto-ai]

Original issue: #19

What is the feature

The feature is to add documentation to the project using GitHub Pages and include usage examples for the library.

Why we need the feature

Documentation is crucial for any project as it helps users understand how to use the library effectively. By providing usage examples, we can make it easier for users to integrate the library into their projects, thereby increasing adoption and reducing support requests.

How to implement and why

1. Set up GitHub Pages:

   • Create a docs directory in the root of the repository.
   • Add a index.md file as the entry point for the documentation.
   • Configure the repository settings to serve the docs directory as a GitHub Pages site.

2. Write Documentation:

   • Use Markdown to write clear and concise documentation in the index.md file.
   • Include sections such as Introduction, Installation, Usage, API Reference, and Contributing.

3. Add Usage Examples:

   • Create a examples directory within the docs directory.
   • Add example scripts or code snippets demonstrating common use cases of the library.
   • Reference these examples in the main documentation to provide context.

4. Continuous Integration:

   • Update the .github/workflows to include a job that checks for broken links in the documentation.
   • Ensure that any changes to the documentation are reviewed and tested before merging.

5. Review and Iterate:

   • Gather feedback from users and contributors to improve the documentation over time.
   • Regularly update the documentation to reflect changes in the library.

About backward compatibility

This feature does not affect the codebase directly, so there are no backward compatibility concerns. The documentation will be an addition to the existing project structure.

Test these changes locally

git checkout -b gitauto/issue-#19-9cd0f630-d95d-47f4-b359-797adaabae63
git pull origin gitauto/issue-#19-9cd0f630-d95d-47f4-b359-797adaabae63

[codacy-production]

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation	Diff coverage
✅ +0.00% (target: -1.00%)	✅ ∅

Coverage variation details

	Coverable lines	Covered lines	Coverage
Common ancestor commit (0975c4f)	1774	4	0.23%
Head commit (16219d1)	1774 (+0)	4 (+0)	0.23% (+0.00%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details

	Coverable lines	Covered lines	Diff coverage
Pull request (#297)	0	0	∅ (not applicable)

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

_{Codacy stopped sending the deprecated coverage status on June 5th, 2024. Learn more}

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[AppVeyorBot]

✅ Build VTEX-SDK-dotnet 2.3.975 completed (commit 4347d0718e by @gitauto-ai[bot])

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 0.22%. Comparing base (78b407c) to head (4a0cf3d).
Report is 1 commits behind head on main.

Additional details and impacted files

@@          Coverage Diff          @@
##            main    #297   +/-   ##
=====================================
  Coverage   0.22%   0.22%           
=====================================
  Files        117     117           
  Lines       1774    1774           
  Branches      75      75           
=====================================
  Hits           4       4           
+ Misses      1770    1768    -2     
- Partials       0       2    +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[AppVeyorBot]

❌ Build VTEX-SDK-dotnet 2.3.995 failed (commit c3bdcb6ce2 by @gstraccini[bot])