wehub-resource-sync
e768098d0e
tools_continuous_delivery / Private PyPI non-main branch release (push) Has been skipped
tools_continuous_delivery / Private PyPI main branch release (push) Failing after 2m42s
Publish Promptflow Doc / Build (push) Has been cancelled
Publish Promptflow Doc / Deploy (push) Has been cancelled
Flake8 Lint / flake8 (push) Has been cancelled
Spell check CI / Spell_Check (push) Has been cancelled
44 lines
3.1 KiB
Markdown
44 lines
3.1 KiB
Markdown
# Promptflow documentation contribute guidelines
|
|
|
|
This folder contains the source code for [prompt flow documentation site](https://microsoft.github.io/promptflow/).
|
|
|
|
This readme file will not be included in above doc site. It keeps a guide for promptflow documentation contributors.
|
|
|
|
## Content
|
|
Below is a table of important doc pages.
|
|
| Category | Article |
|
|
|----------------|----------------|
|
|
|Quick start|[Getting started with prompt flow](./how-to-guides/quick-start.md)|
|
|
|Concepts|[Flows](./concepts/concept-flows.md)<br> [Tools](./concepts/concept-tools.md)<br> [Connections](./concepts/concept-connections.md)<br> [Variants](./concepts/concept-variants.md)<br> |
|
|
|How-to guides|[How to initialize and test a flow](./how-to-guides/develop-a-dag-flow/init-and-test-a-flow.md) <br>[How to run and evaluate a flow](./how-to-guides/run-and-evaluate-a-flow/index.md)<br> [How to tune prompts using variants](./how-to-guides/tune-prompts-with-variants.md)<br>[How to deploy a flow](./how-to-guides/deploy-a-flow/index.md)<br>[How to create and use your own tool package](./how-to-guides/develop-a-tool/create-and-use-tool-package.md)|
|
|
|Tools reference|[LLM tool](./reference/tools-reference/llm-tool.md)<br> [Prompt tool](./reference/tools-reference/prompt-tool.md)<br> [Python tool](./reference/tools-reference/python-tool.md)<br> [Embedding tool](./reference/tools-reference/embedding_tool.md)<br>[SERP API tool](./reference/tools-reference/serp-api-tool.md) ||
|
|
|
|
|
|
## Writing tips
|
|
0. Reach the doc source repository by clicking `Edit this page` on any page.
|
|
|
|
1. Please use :::{admonition} for experimental feature or notes, and admonition with dropdown for the Limitation Part.
|
|
2. Please use ::::{tab-set} to group your sdk/cli example, and put the cli at first. Use :sync: to sync multiple tables .
|
|
3. If you are unclear with the above lines, refer to [get started](./how-to-guides/quick-start.md) to see the usage.
|
|
4. Add gif: Use [ScreenToGif](https://www.screentogif.com/) to record your screen, edit and save as a gif.
|
|
5. Reach more element style at [Sphinx Design Components](https://pydata-sphinx-theme.readthedocs.io/en/latest/user_guide/web-components.html).
|
|
|
|
## Preview your changes
|
|
|
|
|
|
**Local build**: We suggest using local build at the beginning, as it's fast and efficiency.
|
|
|
|
Please refer to [How to build doc site locally](./dev/documentation_guidelines.md#how-to-build-doc-site-locally).
|
|
|
|
|
|
## FAQ
|
|
### Adding image in doc
|
|
Please use markdown syntax `` to reference image, because the relative path of image will be changed after sphinx build, and image placed in html tags can not be referenced when build.
|
|
|
|
### Draw flow chart in doc
|
|
We recommend using the mermaid, learn more from the [mermaid syntax doc](https://mermaid-js.github.io/mermaid/#/./flowchart?id=flowcharts-basic-syntax)
|
|
- Recommend to install [vscode extension](https://marketplace.visualstudio.com/items?itemName=bierner.markdown-mermaid) to preview graph in vscode.
|
|
|
|
## Reference
|
|
- [md-and-rst](https://coderefinery.github.io/sphinx-lesson/md-and-rst/)
|
|
- [sphinx-quickstart](https://www.sphinx-doc.org/en/master/usage/quickstart.html) |