From 9276d25186ba06a8f56ba8737e360e765c8ffd14 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fl=C3=A1vio=20Juvenal?= Date: Thu, 20 Jun 2024 15:46:23 -0300 Subject: [PATCH] Add contributing to docs --- CONTRIBUTING.md | 2 +- docs/contributing.md | 1 + mkdocs.yml | 1 + 3 files changed, 3 insertions(+), 1 deletion(-) create mode 120000 docs/contributing.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a35bfc9..50bb780 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -40,7 +40,7 @@ cd frontend npm run build:watch ``` -Then follow the instructions in the [example README](example/README.md). +Then follow the instructions in the [example README](https://github.com/vintasoftware/django-ai-assistant/tree/main/example#readme). ## Tests diff --git a/docs/contributing.md b/docs/contributing.md new file mode 120000 index 0000000..44fcc63 --- /dev/null +++ b/docs/contributing.md @@ -0,0 +1 @@ +../CONTRIBUTING.md \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 1c55609..49799e1 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -53,6 +53,7 @@ nav: - Reference: - helpers.assistants: assistants-ref.md - helpers.use_cases: use-cases-ref.md + - Contributing: contributing.md plugins: - mkdocstrings: