Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GitAuto: [FEATURE] Add docs #297

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Documentation

on:
push:
branches:
- main
pull_request:
branches:
- main

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Check out repository
uses: actions/checkout@v2
- name: Check for broken links
run: |
# Install link checker
pip install linkchecker
# Run link checker
linkchecker docs/index.md
7 changes: 7 additions & 0 deletions docs/examples/example1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## Example 1: Basic Usage

This example demonstrates the basic usage of the VTEX SDK for .NET.

```csharp
// Example code goes here
```
10 changes: 10 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
## VTEX SDK for .NET

Welcome to the VTEX SDK for .NET documentation.

### Introduction
This documentation provides an overview of the VTEX SDK for .NET, including installation instructions, usage examples, and API references.

### Installation
Instructions on how to install the SDK.

Loading