From 1983ca49bf5199ee9e2ed735f801b24f7f42e7fb Mon Sep 17 00:00:00 2001 From: nikki everett Date: Thu, 10 Oct 2024 14:45:50 -0500 Subject: [PATCH] explain difference between user guide and tutorials and integrations python files in flytesnacks Signed-off-by: nikki everett --- docs/community/contribute/contribute_docs.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/community/contribute/contribute_docs.md b/docs/community/contribute/contribute_docs.md index be1b55d9f6..3b5d996abf 100644 --- a/docs/community/contribute/contribute_docs.md +++ b/docs/community/contribute/contribute_docs.md @@ -25,7 +25,11 @@ To update user guide or deployment documentation, edit the corresponding files i ### Code in user guide documentation -If you want to include tested, runnable example code in user guide documentation, you will need to add your code to the examples directory of the [flytesnacks repository](https://github.com/flyteorg/flytesnacks). Write your code in regular Python, with regular comments. These comments **will not** be extracted from the Python file and turned into user-facing documentation. You can use the `rli` ([remoteliteralinclude](https://github.com/wpilibsuite/sphinxext-remoteliteralinclude/blob/main/README.md)) directive to include snippets of code from your example Python file. +If you want to include tested, runnable example code in user guide documentation, you will need to add your code to the examples directory of the [flytesnacks repository](https://github.com/flyteorg/flytesnacks). Write your code in regular Python, with regular comments. You can use the `rli` ([remoteliteralinclude](https://github.com/wpilibsuite/sphinxext-remoteliteralinclude/blob/main/README.md)) directive to include snippets of code from your example Python file. + +```{important} +Unlike the comments in tutorials and integrations examples Python files, the comments in user guide Python files in flytesnacks **will not** be transformed into Markdown and processed into HTML for the docs site. All prose documentation for the user guide is contained in the Flyte repo, in the `docs/user_guide` directory. +``` ## Contributing to API documentation