TheArchive/zitadel
1
0
Fork 0
mirror of https://github.com/zitadel/zitadel.git synced 2025-08-11 14:57:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: remove embedded content from rendered site (#5183)

Browse Source 
* docs: remove embedded content from rendered site

* integrations applications

* Apply suggestions from code review

Co-authored-by: Fabi <38692350+hifabienne@users.noreply.github.com>

---------

Co-authored-by: Fabi <38692350+hifabienne@users.noreply.github.com>
This commit is contained in:
mffap
2023-02-13 10:20:04 +02:00
committed by GitHub
parent b8e72583eb
commit 0e812cf0f4
16 changed files with 25 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
CONTRIBUTING.md
View File

@@ -280,8 +280,16 @@ docker compose down
## Contribute Docs
Project documentation is made with docusaurus and is located under [./docs](./docs).
### Local Testing
Please refer to the [README](./docs/README.md) for more information and local testing.
### Style Guide
- **Code with variables**: Make sure that code snippets can be used by setting environment variables, instead of manually replacing a placeholder.
- **Embedded files**: When embedding mdx files, make sure the template ist prefixed by "_" (lowdash). The content will be rendered inside the parent page, but is not accessible individually (eg, by search).
### Docs Pull Request
When making a pull request use `docs(<scope>): <short summary>` as title for the semantic release.
Scope can be left empty (omit the brackets) or refer to the top navigation sections.