chunk_id stringlengths 36 36 | source stringclasses 35
values | source_url stringlengths 0 290 | upstream_license stringclasses 1
value | document_id stringlengths 36 36 | chunk_index int64 0 324k | retrieved_at stringclasses 2
values | chunker_version stringclasses 4
values | content_hash stringlengths 15 64 | content stringlengths 50 44.7k | namespace stringclasses 9
values | source_name stringclasses 35
values | raw_text stringlengths 50 44.7k | cleaned_text stringlengths 50 44.7k | tags stringclasses 49
values | collection_name stringclasses 11
values |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
5e896716-1816-4dcd-bbfd-6a5722f549ed | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 170 | opea-semantic-v1 | 1a5e96d4a7f3504a | .. group-tab:: reST
In reST, instead of creating multiple documents with common material except for some
specific sections, you can write one document and provide alternative content
to the reader via a tabbed interface. When the reader clicks a tab, the
content for that tab is displayed. For example:: | ai_ref_knowledge | OPEA Documentation | .. group-tab:: reST
In reST, instead of creating multiple documents with common material except for some
specific sections, you can write one document and provide alternative content
to the reader via a tabbed interface. When the reader clicks a tab, the
content for that tab is displayed. For example:: | .. group-tab:: reST
In reST, instead of creating multiple documents with common material except for some
specific sections, you can write one document and provide alternative content
to the reader via a tabbed interface. When the reader clicks a tab, the
content for that tab is displayed. For example:: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
5f0fea6b-a019-4dc5-889a-c8b219a3330a | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 60 | opea-semantic-v1 | d4479d70ecf1a771 | with a two column span | ... | span | +------------------------+------------+----------+ rows + | body row 4 | ... | ... | too | +------------------------+------------+----------+----------+
.. tabs:: | ai_ref_knowledge | OPEA Documentation | with a two column span | ... | span | +------------------------+------------+----------+ rows + | body row 4 | ... | ... | too | +------------------------+------------+----------+----------+
.. tabs:: | with a two column span | ... | span | +------------------------+------------+----------+ rows + | body row 4 | ... | ... | too | +------------------------+------------+----------+----------+
.. tabs:: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
6045a47d-4e1b-4060-9cc5-489d109a1b21 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 38 | opea-semantic-v1 | 4f90992ace8f0eb4 | * Here's a bullet list item
Here's a paragraph that does look like it's part of that first bullet list item's content because it's indented in the source. | ai_ref_knowledge | OPEA Documentation | * Here's a bullet list item
Here's a paragraph that does look like it's part of that first bullet list item's content because it's indented in the source. | * Here's a bullet list item
Here's a paragraph that does look like it's part of that first bullet list item's content because it's indented in the source. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
60c7dce2-a18f-45ac-95b1-9ada3b9fda47 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 106 | opea-semantic-v1 | 84c62dc54baad691 | the same as those used in HTML entities to insert special characters such as \™ and are defined in the file ``sphinx_build/substitutions.txt`` as listed here:
.. literalinclude:: ../sphinx/substitutions.txt | ai_ref_knowledge | OPEA Documentation | the same as those used in HTML entities to insert special characters such as \™ and are defined in the file ``sphinx_build/substitutions.txt`` as listed here:
.. literalinclude:: ../sphinx/substitutions.txt | the same as those used in HTML entities to insert special characters such as \™ and are defined in the file ``sphinx_build/substitutions.txt`` as listed here:
.. literalinclude:: ../sphinx/substitutions.txt | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
60ca1f33-e1cf-4b36-ac4f-f846b45aed41 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 149 | opea-semantic-v1 | 5a98f90b57e81e6f | Images ******
The image file name specified is relative to the document source file. We
recommend putting images into an ``images`` folder where the document source
is found. The usual image formats handled by a web browser are supported:
JPEG, PNG, GIF, and SVG. Keep the image size only as large as needed,
generally a... | ai_ref_knowledge | OPEA Documentation | Images ******
The image file name specified is relative to the document source file. We
recommend putting images into an ``images`` folder where the document source
is found. The usual image formats handled by a web browser are supported:
JPEG, PNG, GIF, and SVG. Keep the image size only as large as needed,
generally a... | Images ******
The image file name specified is relative to the document source file. We
recommend putting images into an ``images`` folder where the document source
is found. The usual image formats handled by a web browser are supported:
JPEG, PNG, GIF, and SVG. Keep the image size only as large as needed,
generally a... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
610a8198-6dda-4dc1-8ae7-1fb96bcf9417 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 61 | opea-semantic-v1 | 4034593222c3f290 | .. group-tab:: reST
For reST, `List tables <http://docutils.sourceforge.net/docs/ref/rst/directives.html#list-table>`_
are much easier to maintain, but don't support row or column spans:: | ai_ref_knowledge | OPEA Documentation | .. group-tab:: reST
For reST, `List tables <http://docutils.sourceforge.net/docs/ref/rst/directives.html#list-table>`_
are much easier to maintain, but don't support row or column spans:: | .. group-tab:: reST
For reST, `List tables <http://docutils.sourceforge.net/docs/ref/rst/directives.html#list-table>`_
are much easier to maintain, but don't support row or column spans:: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
62a9059e-c474-4f17-8764-55772816682d | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 111 | opea-semantic-v1 | 964a2a2b923bab73 | context at the point of the directive. If an included document fragment contains section structure, the title structure must match and be consistent in context.
.. tabs:: | ai_ref_knowledge | OPEA Documentation | context at the point of the directive. If an included document fragment contains section structure, the title structure must match and be consistent in context.
.. tabs:: | context at the point of the directive. If an included document fragment contains section structure, the title structure must match and be consistent in context.
.. tabs:: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
63b1d963-6ae3-4c09-bfe5-ed40b4f5b115 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 123 | opea-semantic-v1 | a17ee2aa149ba00f | .. include:: mdtable.txt
That's how we showed how a more free-form markdown table syntax would be
rendered in another part of this document. | ai_ref_knowledge | OPEA Documentation | .. include:: mdtable.txt
That's how we showed how a more free-form markdown table syntax would be
rendered in another part of this document. | .. include:: mdtable.txt
That's how we showed how a more free-form markdown table syntax would be
rendered in another part of this document. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
64fef3c5-8911-41ba-b0d7-89ec6a412794 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 31 | opea-semantic-v1 | 39fd1fe55ae330f2 | (or sublist) must have a blank line before it and should be indented at the same level as the preceding paragraph (and not indented itself).
For numbered lists
start with a ``1.`` or ``a.`` for example, and continue with autonumbering by
using a ``#`` sign and a ``.`` as used in the first list item. Indent continuation... | ai_ref_knowledge | OPEA Documentation | (or sublist) must have a blank line before it and should be indented at the same level as the preceding paragraph (and not indented itself).
For numbered lists
start with a ``1.`` or ``a.`` for example, and continue with autonumbering by
using a ``#`` sign and a ``.`` as used in the first list item. Indent continuation... | (or sublist) must have a blank line before it and should be indented at the same level as the preceding paragraph (and not indented itself).
For numbered lists
start with a ``1.`` or ``a.`` for example, and continue with autonumbering by
using a ``#`` sign and a ``.`` as used in the first list item. Indent continuation... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
6869bdf2-2cb1-44be-a47f-06f2045811dc | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 105 | opea-semantic-v1 | b07317be769152d0 | Non-ASCII Characters ********************
You can insert non-ASCII characters such as a Trademark symbol (|trade|) by
using the notation ``|trade|``. (It's also allowed to use the UTF-8
characters directly.) Available replacement names are defined in an include
file used during the Sphinx processing of the reST files. ... | ai_ref_knowledge | OPEA Documentation | Non-ASCII Characters ********************
You can insert non-ASCII characters such as a Trademark symbol (|trade|) by
using the notation ``|trade|``. (It's also allowed to use the UTF-8
characters directly.) Available replacement names are defined in an include
file used during the Sphinx processing of the reST files. ... | Non-ASCII Characters ********************
You can insert non-ASCII characters such as a Trademark symbol (|trade|) by
using the notation ``|trade|``. (It's also allowed to use the UTF-8
characters directly.) Available replacement names are defined in an include
file used during the Sphinx processing of the reST files. ... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
6a8f72af-dc0f-4901-8171-99a2e1c01c9c | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 128 | opea-semantic-v1 | a21b0fdc5a36c3bb | (not the root of the underlying file system). You can reference files outside the document tree root using ``../../`` syntax to get to the file.
You can include an external file and show it as if it were a codeblock
by using the ``literalinclude`` directive:: | ai_ref_knowledge | OPEA Documentation | (not the root of the underlying file system). You can reference files outside the document tree root using ``../../`` syntax to get to the file.
You can include an external file and show it as if it were a codeblock
by using the ``literalinclude`` directive:: | (not the root of the underlying file system). You can reference files outside the document tree root using ``../../`` syntax to get to the file.
You can include an external file and show it as if it were a codeblock
by using the ``literalinclude`` directive:: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
6b50ddc0-96e6-4aa9-ac42-0795351ae459 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 37 | opea-semantic-v1 | e138d7815b95ace8 | Notice how that middle paragraph is out-dented from the bullet list compared with this next example where it's not (yes, it's subtle):
* Here's a bullet list item | ai_ref_knowledge | OPEA Documentation | Notice how that middle paragraph is out-dented from the bullet list compared with this next example where it's not (yes, it's subtle):
* Here's a bullet list item | Notice how that middle paragraph is out-dented from the bullet list compared with this next example where it's not (yes, it's subtle):
* Here's a bullet list item | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
6bff6112-fd3f-4fff-a810-89c60a819866 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 166 | opea-semantic-v1 | 7e47bea53d3e4f10 | In markdown, we've included the MyST ``mermaid`` extensions to enable that text description language to render drawings using::
```{mermaid}
graph LR;
A--> B & C & D;
B--> A & E;
C--> A & E;
D--> A & E;
E--> B & C & D; | ai_ref_knowledge | OPEA Documentation | In markdown, we've included the MyST ``mermaid`` extensions to enable that text description language to render drawings using::
```{mermaid}
graph LR;
A--> B & C & D;
B--> A & E;
C--> A & E;
D--> A & E;
E--> B & C & D; | In markdown, we've included the MyST ``mermaid`` extensions to enable that text description language to render drawings using::
```{mermaid}
graph LR;
A--> B & C & D;
B--> A & E;
C--> A & E;
D--> A & E;
E--> B & C & D; | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
6c584e92-58de-4acc-8ac7-fb1983ccf394 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 55 | opea-semantic-v1 | 8aabd819e4c8d928 | of columns displayed can be reduced based on the available width of the display window, reducing to one column on narrow (phone) screens if necessary.
.. group-tab:: markdown | ai_ref_knowledge | OPEA Documentation | of columns displayed can be reduced based on the available width of the display window, reducing to one column on narrow (phone) screens if necessary.
.. group-tab:: markdown | of columns displayed can be reduced based on the available width of the display window, reducing to one column on narrow (phone) screens if necessary.
.. group-tab:: markdown | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
6c871e8a-dc26-4a1c-a938-3666136384e4 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 2 | opea-semantic-v1 | 761d33a7c23b2f92 | `OPEA Project documentation`_ github.io website. The github.io site also provides navigation and searching that makes it easier to find and read what you're looking for.
You can read details about `reStructuredText`_ and `Sphinx extensions`_, and
`markdown`_ and `MyST extensions`_ from their respective websites. | ai_ref_knowledge | OPEA Documentation | `OPEA Project documentation`_ github.io website. The github.io site also provides navigation and searching that makes it easier to find and read what you're looking for.
You can read details about `reStructuredText`_ and `Sphinx extensions`_, and
`markdown`_ and `MyST extensions`_ from their respective websites. | `OPEA Project documentation`_ github.io website. The github.io site also provides navigation and searching that makes it easier to find and read what you're looking for.
You can read details about `reStructuredText`_ and `Sphinx extensions`_, and
`markdown`_ and `MyST extensions`_ from their respective websites. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
6efeb93c-688b-4359-82db-fb7c526cae69 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 125 | opea-semantic-v1 | 65e09653bb993cb7 | .. group-tab:: markdown
MyST directives can be used to incorporate content from another file
into the current document as if it were part of the current document:: | ai_ref_knowledge | OPEA Documentation | .. group-tab:: markdown
MyST directives can be used to incorporate content from another file
into the current document as if it were part of the current document:: | .. group-tab:: markdown
MyST directives can be used to incorporate content from another file
into the current document as if it were part of the current document:: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
6f3e7398-76f9-4144-9742-d9662164dec3 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 156 | opea-semantic-v1 | 20c96f1190b69cae | The text within a directive block should align with the first character of the directive name.
Keep the line length for documentation fewer than 80 characters to make it
easier for reviewing in GitHub. Long lines due to URL references are an
allowed exception. | ai_ref_knowledge | OPEA Documentation | The text within a directive block should align with the first character of the directive name.
Keep the line length for documentation fewer than 80 characters to make it
easier for reviewing in GitHub. Long lines due to URL references are an
allowed exception. | The text within a directive block should align with the first character of the directive name.
Keep the line length for documentation fewer than 80 characters to make it
easier for reviewing in GitHub. Long lines due to URL references are an
allowed exception. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
6f673e14-1ed4-48ff-b2f6-354643380236 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 130 | opea-semantic-v1 | 6cd522abdbb306cb | ```{literalinclude} relativepath/to/file
You can include reST content, interpreted as reST by using the
``eval-rst`` directive an using the reST syntax and options for an
``include`` directive, such as:: | ai_ref_knowledge | OPEA Documentation | ```{literalinclude} relativepath/to/file
You can include reST content, interpreted as reST by using the
``eval-rst`` directive an using the reST syntax and options for an
``include`` directive, such as:: | ```{literalinclude} relativepath/to/file
You can include reST content, interpreted as reST by using the
``eval-rst`` directive an using the reST syntax and options for an
``include`` directive, such as:: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
725925e6-5be8-4335-84e8-e0a94eb87644 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 54 | opea-semantic-v1 | 7ca9c5a3948c49b3 | short items * that should be * displayed * horizontally * so it doesn't * use up so much * space on * the page
A maximum of three columns will be displayed if you use ``rst-columns``
(or ``rst-columns3``), and two columns for ``rst-columns2``. The number
of columns displayed can be reduced based on the available widt... | ai_ref_knowledge | OPEA Documentation | short items * that should be * displayed * horizontally * so it doesn't * use up so much * space on * the page
A maximum of three columns will be displayed if you use ``rst-columns``
(or ``rst-columns3``), and two columns for ``rst-columns2``. The number
of columns displayed can be reduced based on the available widt... | short items * that should be * displayed * horizontally * so it doesn't * use up so much * space on * the page
A maximum of three columns will be displayed if you use ``rst-columns``
(or ``rst-columns3``), and two columns for ``rst-columns2``. The number
of columns displayed can be reduced based on the available widt... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
73f4632e-13ef-454e-bcb8-c8336141deba | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 53 | opea-semantic-v1 | 3936f27383e72131 | short items * that should be * displayed * horizontally * so it doesn't * use up so much * space on * the page
would be rendered as: | ai_ref_knowledge | OPEA Documentation | short items * that should be * displayed * horizontally * so it doesn't * use up so much * space on * the page
would be rendered as: | short items * that should be * displayed * horizontally * so it doesn't * use up so much * space on * the page
would be rendered as: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
749bf6a1-a32c-4e96-b6a1-0887579fb8b0 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 78 | opea-semantic-v1 | f2c4b91c388f6d55 | generate the HTML documentation is the same tagged version for all the repos we want to reference.
For example, a GitHub
link to the reST file used to create this document can be generated
using ``:docs_blob:`developer-guides/doc_guidelines```, which will
appear as :docs_blob:`developer-guides/doc_guidelines.rst`, a li... | ai_ref_knowledge | OPEA Documentation | generate the HTML documentation is the same tagged version for all the repos we want to reference.
For example, a GitHub
link to the reST file used to create this document can be generated
using ``:docs_blob:`developer-guides/doc_guidelines```, which will
appear as :docs_blob:`developer-guides/doc_guidelines.rst`, a li... | generate the HTML documentation is the same tagged version for all the repos we want to reference.
For example, a GitHub
link to the reST file used to create this document can be generated
using ``:docs_blob:`developer-guides/doc_guidelines```, which will
appear as :docs_blob:`developer-guides/doc_guidelines.rst`, a li... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
77c1e7f1-84ef-45fd-9171-380bc56b40de | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 9 | opea-semantic-v1 | 1b0960778c03d49f | Documentation Organization **************************
Documentation is maintained and updated the same as the project's code within
the opea-project GitHub repos. There are many ``README.md`` and other markdown files within the various
repos along with the other files for those components. This is good because it
keeps... | ai_ref_knowledge | OPEA Documentation | Documentation Organization **************************
Documentation is maintained and updated the same as the project's code within
the opea-project GitHub repos. There are many ``README.md`` and other markdown files within the various
repos along with the other files for those components. This is good because it
keeps... | Documentation Organization **************************
Documentation is maintained and updated the same as the project's code within
the opea-project GitHub repos. There are many ``README.md`` and other markdown files within the various
repos along with the other files for those components. This is good because it
keeps... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
796d5534-c049-4b42-ad19-7433df4b6fa8 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 109 | opea-semantic-v1 | ddb16933df849cd6 | Include Content from Other Files ********************************
You can directly incorporate a document fragment from another file into your reST or
markdown content by using an ``include`` directive. | ai_ref_knowledge | OPEA Documentation | Include Content from Other Files ********************************
You can directly incorporate a document fragment from another file into your reST or
markdown content by using an ``include`` directive. | Include Content from Other Files ********************************
You can directly incorporate a document fragment from another file into your reST or
markdown content by using an ``include`` directive. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
7a88ab33-7fde-4a07-a0cc-6dd35a11a859 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 16 | opea-semantic-v1 | b281742f3a5c0738 | Additional heading-level depth is discouraged, but if needed, use ``%`` (H5), ``+`` (H6), and ``@`` (H7).
The heading underline must be at least as long as the title it's under. | ai_ref_knowledge | OPEA Documentation | Additional heading-level depth is discouraged, but if needed, use ``%`` (H5), ``+`` (H6), and ``@`` (H7).
The heading underline must be at least as long as the title it's under. | Additional heading-level depth is discouraged, but if needed, use ``%`` (H5), ``+`` (H6), and ``@`` (H7).
The heading underline must be at least as long as the title it's under. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
7ba313db-2b89-403a-8882-7763c6884c06 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 135 | opea-semantic-v1 | c94d7bf764287970 | and the first line of the code-block body, and the body content is indented three spaces (to the first non-blank space of the directive name).
This example would render as: | ai_ref_knowledge | OPEA Documentation | and the first line of the code-block body, and the body content is indented three spaces (to the first non-blank space of the directive name).
This example would render as: | and the first line of the code-block body, and the body content is indented three spaces (to the first non-blank space of the directive name).
This example would render as: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
80be481a-78ed-424c-a80f-0994f545b2a6 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 69 | opea-semantic-v1 | 86cb2ae570bb508c | 1 column 2 | yes, it's row 1 column 3| |row 2 col 1 | row 2 column 2 | row 2 col 3 |
That would be rendered as: | ai_ref_knowledge | OPEA Documentation | 1 column 2 | yes, it's row 1 column 3| |row 2 col 1 | row 2 column 2 | row 2 col 3 |
That would be rendered as: | 1 column 2 | yes, it's row 1 column 3| |row 2 col 1 | row 2 column 2 | row 2 col 3 |
That would be rendered as: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
826b1ef1-1f16-47bd-bdab-bb20172ef1aa | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 182 | opea-semantic-v1 | d6f3270ba8aabf02 | each colon fence must be terminated with a matching colon fence because indenting is not used for content within the fenced area (normal for markdown).
Here's what that would look like with two sets of tabbed alternative
content: | ai_ref_knowledge | OPEA Documentation | each colon fence must be terminated with a matching colon fence because indenting is not used for content within the fenced area (normal for markdown).
Here's what that would look like with two sets of tabbed alternative
content: | each colon fence must be terminated with a matching colon fence because indenting is not used for content within the fenced area (normal for markdown).
Here's what that would look like with two sets of tabbed alternative
content: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
83754c80-653a-4059-bf8f-cc2abb96dc2d | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 112 | opea-semantic-v1 | 5a5002e0185b37ea | .. group-tab:: reST
In reST, you incorporate content from another file using an include
directive. Unless options are given, the included file is parsed in the
current document's context:: | ai_ref_knowledge | OPEA Documentation | .. group-tab:: reST
In reST, you incorporate content from another file using an include
directive. Unless options are given, the included file is parsed in the
current document's context:: | .. group-tab:: reST
In reST, you incorporate content from another file using an include
directive. Unless options are given, the included file is parsed in the
current document's context:: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
8420ac41-ae06-497c-87db-a3b8e3ad995c | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 168 | opea-semantic-v1 | 7bf62d658d50d76d | .. mermaid::
graph LR;
A--> B & C & D;
B--> A & E;
C--> A & E;
D--> A & E;
E--> B & C & D; | ai_ref_knowledge | OPEA Documentation | .. mermaid::
graph LR;
A--> B & C & D;
B--> A & E;
C--> A & E;
D--> A & E;
E--> B & C & D; | .. mermaid::
graph LR;
A--> B & C & D;
B--> A & E;
C--> A & E;
D--> A & E;
E--> B & C & D; | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
84a80d12-a066-4575-993b-6013888a80c0 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 177 | opea-semantic-v1 | f017b254b8379b8b | While markdown does not have native support for tabbed alternatives, we do support this in the OPEA markdown documentation with the Myst Parser extension::
::::{tab-set} | ai_ref_knowledge | OPEA Documentation | While markdown does not have native support for tabbed alternatives, we do support this in the OPEA markdown documentation with the Myst Parser extension::
::::{tab-set} | While markdown does not have native support for tabbed alternatives, we do support this in the OPEA markdown documentation with the Myst Parser extension::
::::{tab-set} | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
867cc62b-7b79-4d8c-ad4d-4eec05894a68 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 131 | opea-semantic-v1 | e9c2130534b66d4b | can include reST content, interpreted as reST by using the ``eval-rst`` directive an using the reST syntax and options for an ``include`` directive, such as::
```{eval-rst}
.. include:: path/to-file | ai_ref_knowledge | OPEA Documentation | can include reST content, interpreted as reST by using the ``eval-rst`` directive an using the reST syntax and options for an ``include`` directive, such as::
```{eval-rst}
.. include:: path/to-file | can include reST content, interpreted as reST by using the ``eval-rst`` directive an using the reST syntax and options for an ``include`` directive, such as::
```{eval-rst}
.. include:: path/to-file | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
87069eb6-724c-4a70-a572-106f151a5987 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 127 | opea-semantic-v1 | 5c42fa25522ca4e5 | ```{include} relativepath/to/file
The ``relativepath/to/file`` can starts with a ``/`` to indicate a path
starting from the root of the document directory tree (not the root of
the underlying file system). You can reference files outside the
document tree root using ``../../`` syntax to get to the file. | ai_ref_knowledge | OPEA Documentation | ```{include} relativepath/to/file
The ``relativepath/to/file`` can starts with a ``/`` to indicate a path
starting from the root of the document directory tree (not the root of
the underlying file system). You can reference files outside the
document tree root using ``../../`` syntax to get to the file. | ```{include} relativepath/to/file
The ``relativepath/to/file`` can starts with a ``/`` to indicate a path
starting from the root of the document directory tree (not the root of
the underlying file system). You can reference files outside the
document tree root using ``../../`` syntax to get to the file. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
8a0eb535-11fe-464e-acb7-22eda714f852 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 108 | opea-semantic-v1 | c11a4fad7438dfe5 | We've kept the substitutions list small but you can add others as needed by submitting a change to the ``substitutions.txt`` file.
Include Content from Other Files
******************************** | ai_ref_knowledge | OPEA Documentation | We've kept the substitutions list small but you can add others as needed by submitting a change to the ``substitutions.txt`` file.
Include Content from Other Files
******************************** | We've kept the substitutions list small but you can add others as needed by submitting a change to the ``substitutions.txt`` file.
Include Content from Other Files
******************************** | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
8b9fa7ba-be37-427d-8d36-e963196b16da | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 18 | opea-semantic-v1 | 937e732ba9e5abd3 | .. group-tab:: markdown
In markdown, headings are indicated as a line beginning with a ``#``
character, with additional ``#`` characters indicating a deeper heading
level, e.g., ``#`` for H1 (title), ``##`` for H2 headings, ``###`` for H3
headings, and so on.) | ai_ref_knowledge | OPEA Documentation | .. group-tab:: markdown
In markdown, headings are indicated as a line beginning with a ``#``
character, with additional ``#`` characters indicating a deeper heading
level, e.g., ``#`` for H1 (title), ``##`` for H2 headings, ``###`` for H3
headings, and so on.) | .. group-tab:: markdown
In markdown, headings are indicated as a line beginning with a ``#``
character, with additional ``#`` characters indicating a deeper heading
level, e.g., ``#`` for H1 (title), ``##`` for H2 headings, ``###`` for H3
headings, and so on.) | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
8c1a675a-1c3e-4882-be1d-6fedf5ce9a5d | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 64 | opea-semantic-v1 | 37543a42bda7ea29 | - body row 1, column 3 * - body row 2, column 1 - body row 2, column 2 - body row 2, column 3
This example would render as: | ai_ref_knowledge | OPEA Documentation | - body row 1, column 3 * - body row 2, column 1 - body row 2, column 2 - body row 2, column 3
This example would render as: | - body row 1, column 3 * - body row 2, column 1 - body row 2, column 2 - body row 2, column 3
This example would render as: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
8c6f3627-a645-440b-b927-42d2f1b7b054 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 89 | opea-semantic-v1 | 36686aa41384291d | Documentation Guidelines ########################
Other ``.rst`` documents can link to this document using the
``:ref:`doc_guidelines``` tag, and it will appear as :ref:`doc_guidelines`. This type of internal cross-reference works across multiple files. The link
text is obtained from the document source, so if the ti... | ai_ref_knowledge | OPEA Documentation | Documentation Guidelines ########################
Other ``.rst`` documents can link to this document using the
``:ref:`doc_guidelines``` tag, and it will appear as :ref:`doc_guidelines`. This type of internal cross-reference works across multiple files. The link
text is obtained from the document source, so if the ti... | Documentation Guidelines ########################
Other ``.rst`` documents can link to this document using the
``:ref:`doc_guidelines``` tag, and it will appear as :ref:`doc_guidelines`. This type of internal cross-reference works across multiple files. The link
text is obtained from the document source, so if the ti... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
8e373c96-e616-4cb1-a3a1-c1b7c5334ea5 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 155 | opea-semantic-v1 | 2c995b1fa2226715 | 1. And for numbered list items, the continuation line should align with the text of the line above.
The text within a directive block should align with the
first character of the directive name. | ai_ref_knowledge | OPEA Documentation | 1. And for numbered list items, the continuation line should align with the text of the line above.
The text within a directive block should align with the
first character of the directive name. | 1. And for numbered list items, the continuation line should align with the text of the line above.
The text within a directive block should align with the
first character of the directive name. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
913e88d9-71b0-4d70-884d-afc6399ffc12 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 153 | opea-semantic-v1 | 76a76759a670e02b | the way content is rendered, too. For lists and directives, indent the content text to the first non-blank space in the preceding line. For example:
* List item that spans multiple lines of text
showing where to indent the continuation line. | ai_ref_knowledge | OPEA Documentation | the way content is rendered, too. For lists and directives, indent the content text to the first non-blank space in the preceding line. For example:
* List item that spans multiple lines of text
showing where to indent the continuation line. | the way content is rendered, too. For lists and directives, indent the content text to the first non-blank space in the preceding line. For example:
* List item that spans multiple lines of text
showing where to indent the continuation line. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
91eeab01-7f40-43cc-822b-519dff6547a2 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 94 | opea-semantic-v1 | c2b06d14e60ca2c9 | docs repo community directory you would use ``:doc:`Contribution Guide </community/CONTRIBUTING>```. Notice you can change the link text using the normal reST role syntax shown here.
.. group-tab:: markdown | ai_ref_knowledge | OPEA Documentation | docs repo community directory you would use ``:doc:`Contribution Guide </community/CONTRIBUTING>```. Notice you can change the link text using the normal reST role syntax shown here.
.. group-tab:: markdown | docs repo community directory you would use ``:doc:`Contribution Guide </community/CONTRIBUTING>```. Notice you can change the link text using the normal reST role syntax shown here.
.. group-tab:: markdown | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
9230b332-bf4d-41c2-a52e-d07567657972 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 185 | opea-semantic-v1 | 1af8a884dd0410b5 | First Instruction Step **********************
This is the first instruction step material. You can do the usual paragraph
and pictures as you'd use in normal document writing. Write the heading to be
a summary of what the step is (the step numbering is automated so you can move
steps around easily if needed). | ai_ref_knowledge | OPEA Documentation | First Instruction Step **********************
This is the first instruction step material. You can do the usual paragraph
and pictures as you'd use in normal document writing. Write the heading to be
a summary of what the step is (the step numbering is automated so you can move
steps around easily if needed). | First Instruction Step **********************
This is the first instruction step material. You can do the usual paragraph
and pictures as you'd use in normal document writing. Write the heading to be
a summary of what the step is (the step numbering is automated so you can move
steps around easily if needed). | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
93545534-94c2-465a-941a-cbfa768eab8c | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 42 | opea-semantic-v1 | 263d76831dd18513 | If there wasn't a blank line before it, it would be a continuation of the previous list (or paragraph). #. It has two items too.
a. This is a numbered list using alphabetic list headings
#. It has three items (and uses autonumbering for the rest of the list)
#. Here's the third item. Use consistent punctuation on the... | ai_ref_knowledge | OPEA Documentation | If there wasn't a blank line before it, it would be a continuation of the previous list (or paragraph). #. It has two items too.
a. This is a numbered list using alphabetic list headings
#. It has three items (and uses autonumbering for the rest of the list)
#. Here's the third item. Use consistent punctuation on the... | If there wasn't a blank line before it, it would be a continuation of the previous list (or paragraph). #. It has two items too.
a. This is a numbered list using alphabetic list headings
#. It has three items (and uses autonumbering for the rest of the list)
#. Here's the third item. Use consistent punctuation on the... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
94cb0dd8-4a96-4395-8047-1f1514c99976 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 104 | opea-semantic-v1 | 960ed6108d69a605 | example deployment options document found at ``examples/ChatQnA/deploy/index.rst`` has that ``chatqna-example-deployment`` label at the top we can reference instead of knowing the path to the document.
Non-ASCII Characters
******************** | ai_ref_knowledge | OPEA Documentation | example deployment options document found at ``examples/ChatQnA/deploy/index.rst`` has that ``chatqna-example-deployment`` label at the top we can reference instead of knowing the path to the document.
Non-ASCII Characters
******************** | example deployment options document found at ``examples/ChatQnA/deploy/index.rst`` has that ``chatqna-example-deployment`` label at the top we can reference instead of knowing the path to the document.
Non-ASCII Characters
******************** | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
967e82ca-0b14-4e4c-918c-41b80184de43 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 35 | opea-semantic-v1 | 288fa040153de47f | Here's a paragraph that should be part of that first bullet list item's content.
* Here's a second bullet list item | ai_ref_knowledge | OPEA Documentation | Here's a paragraph that should be part of that first bullet list item's content.
* Here's a second bullet list item | Here's a paragraph that should be part of that first bullet list item's content.
* Here's a second bullet list item | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
99d1bf7f-3f58-44d5-8156-c35d21717191 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 25 | opea-semantic-v1 | b5537c738fa1e083 | marks. For example, using an asterisk to indicate multiplication, such as ``2 * (x + y)`` will not be interpreted as an unterminated italics section.
.. group-tab:: markdown | ai_ref_knowledge | OPEA Documentation | marks. For example, using an asterisk to indicate multiplication, such as ``2 * (x + y)`` will not be interpreted as an unterminated italics section.
.. group-tab:: markdown | marks. For example, using an asterisk to indicate multiplication, such as ``2 * (x + y)`` will not be interpreted as an unterminated italics section.
.. group-tab:: markdown | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
9a406994-291b-4cab-9414-218fde20f0bf | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 114 | opea-semantic-v1 | c99c2e389e8d818d | .. include:: path/to/file
And now we're back to the original document after the content in the
included file, as if that content were directly in the current file. | ai_ref_knowledge | OPEA Documentation | .. include:: path/to/file
And now we're back to the original document after the content in the
included file, as if that content were directly in the current file. | .. include:: path/to/file
And now we're back to the original document after the content in the
included file, as if that content were directly in the current file. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
9afd0fc2-0a66-4695-adad-40a0eeeb3920 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 49 | opea-semantic-v1 | 634cef061dd06ea4 | html Build the HTML output for the project
clean
Remove all generated output, restoring the folders to a
clean state. | ai_ref_knowledge | OPEA Documentation | html Build the HTML output for the project
clean
Remove all generated output, restoring the folders to a
clean state. | html Build the HTML output for the project
clean
Remove all generated output, restoring the folders to a
clean state. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
9c6e3c7c-0085-4d77-9c66-5d50bd61856f | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 132 | opea-semantic-v1 | 4f70abf9c5a9273b | .. group-tab:: reST
Use the reST ``code-block`` directive to create a highlighted block of
fixed-width text, typically used for showing formatted code or console
commands and output. Smart syntax highlighting is also supported (using the
Pygments package). You can also directly specify the highlighting language. For... | ai_ref_knowledge | OPEA Documentation | .. group-tab:: reST
Use the reST ``code-block`` directive to create a highlighted block of
fixed-width text, typically used for showing formatted code or console
commands and output. Smart syntax highlighting is also supported (using the
Pygments package). You can also directly specify the highlighting language. For... | .. group-tab:: reST
Use the reST ``code-block`` directive to create a highlighted block of
fixed-width text, typically used for showing formatted code or console
commands and output. Smart syntax highlighting is also supported (using the
Pygments package). You can also directly specify the highlighting language. For... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
9cc9d250-9c39-42a7-b235-594bbed8f94a | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 41 | opea-semantic-v1 | ad71301bf7f666ee | second item and has more than one line of text. Additional lines are indented to the first character of the text of the bullet list.
1. This is a new numbered list. If there wasn't a blank line before it,
it would be a continuation of the previous list (or paragraph). #. It has two items too. | ai_ref_knowledge | OPEA Documentation | second item and has more than one line of text. Additional lines are indented to the first character of the text of the bullet list.
1. This is a new numbered list. If there wasn't a blank line before it,
it would be a continuation of the previous list (or paragraph). #. It has two items too. | second item and has more than one line of text. Additional lines are indented to the first character of the text of the bullet list.
1. This is a new numbered list. If there wasn't a blank line before it,
it would be a continuation of the previous list (or paragraph). #. It has two items too. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
9e22a778-8b4d-4396-8965-f88d03540cc2 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 80 | opea-semantic-v1 | 37627165374faf1c | to see the difference.
If you don't want the whole path to the file name to
appear in the text, you use the usual linking notation to define what link text
is shown, for example, ``:docs_blob:`Guidelines <developer-guides/doc_guidelines.rst>```
would show up as simply :docs_blob:`Guidelines <developer-guides/doc_guidel... | ai_ref_knowledge | OPEA Documentation | to see the difference.
If you don't want the whole path to the file name to
appear in the text, you use the usual linking notation to define what link text
is shown, for example, ``:docs_blob:`Guidelines <developer-guides/doc_guidelines.rst>```
would show up as simply :docs_blob:`Guidelines <developer-guides/doc_guidel... | to see the difference.
If you don't want the whole path to the file name to
appear in the text, you use the usual linking notation to define what link text
is shown, for example, ``:docs_blob:`Guidelines <developer-guides/doc_guidelines.rst>```
would show up as simply :docs_blob:`Guidelines <developer-guides/doc_guidel... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
9e541c1a-f708-45e1-be2e-c3d0c4cf2984 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 180 | opea-semantic-v1 | c13bcd4bc3074b6b | This content will show on the Windows tab ::: ::::
Each ``tab-set`` used a ``tab-item`` for each tabbed alternative. Adding
the ``:sync: <tabname>`` option causes all ``tab-set`` that share that
``tab-item`` name to be synchronized through the document (all the tabs
will change to the selected tab). | ai_ref_knowledge | OPEA Documentation | This content will show on the Windows tab ::: ::::
Each ``tab-set`` used a ``tab-item`` for each tabbed alternative. Adding
the ``:sync: <tabname>`` option causes all ``tab-set`` that share that
``tab-item`` name to be synchronized through the document (all the tabs
will change to the selected tab). | This content will show on the Windows tab ::: ::::
Each ``tab-set`` used a ``tab-item`` for each tabbed alternative. Adding
the ``:sync: <tabname>`` option causes all ``tab-set`` that share that
``tab-item`` name to be synchronized through the document (all the tabs
will change to the selected tab). | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
a0384107-a47e-4793-a05c-17fe8c875d91 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 0 | opea-semantic-v1 | 9045a6de50a0374a | Documentation Guidelines ########################
OPEA Project content is written using the `markdown`_ (``.md``) with `MyST extensions`_
and `reStructuredText`_ markup language (``.rst``) with `Sphinx extensions`_, and processed
using `Sphinx`_ to create a formatted stand-alone website. Developers can
view this conten... | ai_ref_knowledge | OPEA Documentation | Documentation Guidelines ########################
OPEA Project content is written using the `markdown`_ (``.md``) with `MyST extensions`_
and `reStructuredText`_ markup language (``.rst``) with `Sphinx extensions`_, and processed
using `Sphinx`_ to create a formatted stand-alone website. Developers can
view this conten... | Documentation Guidelines ########################
OPEA Project content is written using the `markdown`_ (``.md``) with `MyST extensions`_
and `reStructuredText`_ markup language (``.rst``) with `Sphinx extensions`_, and processed
using `Sphinx`_ to create a formatted stand-alone website. Developers can
view this conten... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
a1cce0c6-261f-491b-89ec-1db60f726a78 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 164 | opea-semantic-v1 | 361cf5fadfd71fe9 | graph LR; A--> B & C; B--> A & C; C--> A & B;
See the `Mermaid User Guide <https://mermaid.js.org/intro/getting-started.html>`_ for more
information. | ai_ref_knowledge | OPEA Documentation | graph LR; A--> B & C; B--> A & C; C--> A & B;
See the `Mermaid User Guide <https://mermaid.js.org/intro/getting-started.html>`_ for more
information. | graph LR; A--> B & C; B--> A & C; C--> A & B;
See the `Mermaid User Guide <https://mermaid.js.org/intro/getting-started.html>`_ for more
information. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
a4022364-c077-4f6c-9250-b11c6a7f2ff6 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 6 | opea-semantic-v1 | 61e968e76fd6557f | Sphinx in 2008. These days, reST is supported by GitHub and major projects use it for their documentation, including the Linux kernel, OpenCV and LLVM/Clang.
ReStructuredText is more fully-featured, much more standardized and uniform, and
has built-in support for extensions. The markdown language has no standard way
to... | ai_ref_knowledge | OPEA Documentation | Sphinx in 2008. These days, reST is supported by GitHub and major projects use it for their documentation, including the Linux kernel, OpenCV and LLVM/Clang.
ReStructuredText is more fully-featured, much more standardized and uniform, and
has built-in support for extensions. The markdown language has no standard way
to... | Sphinx in 2008. These days, reST is supported by GitHub and major projects use it for their documentation, including the Linux kernel, OpenCV and LLVM/Clang.
ReStructuredText is more fully-featured, much more standardized and uniform, and
has built-in support for extensions. The markdown language has no standard way
to... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
a43866de-eb31-4fac-a1d8-b3fb1ee9f741 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 126 | opea-semantic-v1 | 1f35e81e1d431b10 | MyST directives can be used to incorporate content from another file into the current document as if it were part of the current document::
```{include} relativepath/to/file | ai_ref_knowledge | OPEA Documentation | MyST directives can be used to incorporate content from another file into the current document as if it were part of the current document::
```{include} relativepath/to/file | MyST directives can be used to incorporate content from another file into the current document as if it were part of the current document::
```{include} relativepath/to/file | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
a47a943a-6d11-43ef-aaf4-11786665f483 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 161 | opea-semantic-v1 | 5c4be4fdad428740 | In reST, we've included the ``graphviz`` Sphinx extension to enable that text description language to render drawings. For more information, see
We've also included an extension providing ``mermaid`` support that also enables
that text description language to render drawings using:: | ai_ref_knowledge | OPEA Documentation | In reST, we've included the ``graphviz`` Sphinx extension to enable that text description language to render drawings. For more information, see
We've also included an extension providing ``mermaid`` support that also enables
that text description language to render drawings using:: | In reST, we've included the ``graphviz`` Sphinx extension to enable that text description language to render drawings. For more information, see
We've also included an extension providing ``mermaid`` support that also enables
that text description language to render drawings using:: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
a52c108b-ae7b-4aab-b919-0864a88480fe | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 14 | opea-semantic-v1 | 7c436fd400ff26d8 | indicator for headings.) For consistency in our documentation, we define the order of characters used to indicate the nested levels in the table of contents:
* Use ``#`` for the Document title underline character (H1)
* Use ``*`` for the First sub-section heading level (H2)
* Use ``=`` for the Second sub-section head... | ai_ref_knowledge | OPEA Documentation | indicator for headings.) For consistency in our documentation, we define the order of characters used to indicate the nested levels in the table of contents:
* Use ``#`` for the Document title underline character (H1)
* Use ``*`` for the First sub-section heading level (H2)
* Use ``=`` for the Second sub-section head... | indicator for headings.) For consistency in our documentation, we define the order of characters used to indicate the nested levels in the table of contents:
* Use ``#`` for the Document title underline character (H1)
* Use ``*`` for the First sub-section heading level (H2)
* Use ``=`` for the Second sub-section head... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
a6f2d5ef-55b7-407a-a6b0-7595a9ed4e33 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 134 | opea-semantic-v1 | 0e10e19cc083d168 | struct _k_object { char *name; u8_t perms[CONFIG_MAX_THREAD_BYTES]; u8_t type; u8_t flags; u32_t data; } __packed;
Note that there is a blank line between the ``code-block`` directive and the
first line of the code-block body, and the body content is indented three
spaces (to the first non-blank space of the directiv... | ai_ref_knowledge | OPEA Documentation | struct _k_object { char *name; u8_t perms[CONFIG_MAX_THREAD_BYTES]; u8_t type; u8_t flags; u32_t data; } __packed;
Note that there is a blank line between the ``code-block`` directive and the
first line of the code-block body, and the body content is indented three
spaces (to the first non-blank space of the directiv... | struct _k_object { char *name; u8_t perms[CONFIG_MAX_THREAD_BYTES]; u8_t type; u8_t flags; u32_t data; } __packed;
Note that there is a blank line between the ``code-block`` directive and the
first line of the code-block body, and the body content is indented three
spaces (to the first non-blank space of the directiv... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
a705e099-7227-424d-9738-9348f3ae4696 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 30 | opea-semantic-v1 | 8fc59b86ff5e9350 | For bullet lists, place an asterisk (``*``) or hyphen (``-``) at the start of a paragraph and indent continuation lines with two spaces.
The first item in a list (or sublist) must have a blank line before it and
should be indented at the same level as the preceding paragraph (and not
indented itself). | ai_ref_knowledge | OPEA Documentation | For bullet lists, place an asterisk (``*``) or hyphen (``-``) at the start of a paragraph and indent continuation lines with two spaces.
The first item in a list (or sublist) must have a blank line before it and
should be indented at the same level as the preceding paragraph (and not
indented itself). | For bullet lists, place an asterisk (``*``) or hyphen (``-``) at the start of a paragraph and indent continuation lines with two spaces.
The first item in a list (or sublist) must have a blank line before it and
should be indented at the same level as the preceding paragraph (and not
indented itself). | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
abc1382f-0c72-46ea-bc41-f9f974d0ef7d | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 3 | opea-semantic-v1 | f216d822b2b37326 | You can read details about `reStructuredText`_ and `Sphinx extensions`_, and `markdown`_ and `MyST extensions`_ from their respective websites.
This document provides a quick reference for commonly used markdown and reST
with MyST and Sphinx-defined directives and roles used to create the documentation
you're reading. ... | ai_ref_knowledge | OPEA Documentation | You can read details about `reStructuredText`_ and `Sphinx extensions`_, and `markdown`_ and `MyST extensions`_ from their respective websites.
This document provides a quick reference for commonly used markdown and reST
with MyST and Sphinx-defined directives and roles used to create the documentation
you're reading. ... | You can read details about `reStructuredText`_ and `Sphinx extensions`_, and `markdown`_ and `MyST extensions`_ from their respective websites.
This document provides a quick reference for commonly used markdown and reST
with MyST and Sphinx-defined directives and roles used to create the documentation
you're reading. ... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
ae2d991b-b341-442f-b62c-ef39b69ae271 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 34 | opea-semantic-v1 | aaf50676b9e65d0a | * Here's a bullet list item
Here's a paragraph that should be part of that first bullet list item's content. | ai_ref_knowledge | OPEA Documentation | * Here's a bullet list item
Here's a paragraph that should be part of that first bullet list item's content. | * Here's a bullet list item
Here's a paragraph that should be part of that first bullet list item's content. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
af43bd2f-9d8c-462b-b7ac-0121907dcc9b | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 48 | opea-semantic-v1 | b3a80adad2f8ceef | ``html`` Build the HTML output for the project
``clean``
Remove all generated output, restoring the folders to a
clean state. | ai_ref_knowledge | OPEA Documentation | ``html`` Build the HTML output for the project
``clean``
Remove all generated output, restoring the folders to a
clean state. | ``html`` Build the HTML output for the project
``clean``
Remove all generated output, restoring the folders to a
clean state. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
b184c7bb-6725-4a84-8ec6-84e71fc00727 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 167 | opea-semantic-v1 | f485c789ea66e7ea | LR; A--> B & C & D; B--> A & E; C--> A & E; D--> A & E; E--> B & C & D;
This will be rendered into this graph drawing: | ai_ref_knowledge | OPEA Documentation | LR; A--> B & C & D; B--> A & E; C--> A & E; D--> A & E; E--> B & C & D;
This will be rendered into this graph drawing: | LR; A--> B & C & D; B--> A & E; C--> A & E; D--> A & E; E--> B & C & D;
This will be rendered into this graph drawing: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
b1da47c9-2cf0-495a-ac99-0dad15a48f83 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 81 | opea-semantic-v1 | 4ad55a7d458e1160 | text, you use the usual linking notation to define what link text is shown, for example, ``:docs_blob:`Guidelines <developer-guides/doc_guidelines.rst>``` would show up as simply :docs_blob:`Guidelines <developer-guides/doc_guidelines.rst>`.
.. _internal-linking: | ai_ref_knowledge | OPEA Documentation | text, you use the usual linking notation to define what link text is shown, for example, ``:docs_blob:`Guidelines <developer-guides/doc_guidelines.rst>``` would show up as simply :docs_blob:`Guidelines <developer-guides/doc_guidelines.rst>`.
.. _internal-linking: | text, you use the usual linking notation to define what link text is shown, for example, ``:docs_blob:`Guidelines <developer-guides/doc_guidelines.rst>``` would show up as simply :docs_blob:`Guidelines <developer-guides/doc_guidelines.rst>`.
.. _internal-linking: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
b3b0f162-3996-47bd-85e5-3d8b5fa2db7b | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 181 | opea-semantic-v1 | 1d5135e19acbd28e | <tabname>`` option causes all ``tab-set`` that share that ``tab-item`` name to be synchronized through the document (all the tabs will change to the selected tab).
Note the use of three colons as the fence instead of the normal use of
three backticks. This allows use of three backtics within a tab for
denoting a code... | ai_ref_knowledge | OPEA Documentation | <tabname>`` option causes all ``tab-set`` that share that ``tab-item`` name to be synchronized through the document (all the tabs will change to the selected tab).
Note the use of three colons as the fence instead of the normal use of
three backticks. This allows use of three backtics within a tab for
denoting a code... | <tabname>`` option causes all ``tab-set`` that share that ``tab-item`` name to be synchronized through the document (all the tabs will change to the selected tab).
Note the use of three colons as the fence instead of the normal use of
three backticks. This allows use of three backtics within a tab for
denoting a code... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
b4b50daf-eeec-442c-a398-ea6f78020b7f | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 138 | opea-semantic-v1 | 3b88d1593f5a54a3 | for the ``code-block`` directive, including ``c``, ``python``, and ``rst``, and also ``console``, ``bash``, or ``shell``. If you want no syntax highlighting, specify ``none``. For example:
This block of text would be styled with a background
and box, but with no syntax highlighting. | ai_ref_knowledge | OPEA Documentation | for the ``code-block`` directive, including ``c``, ``python``, and ``rst``, and also ``console``, ``bash``, or ``shell``. If you want no syntax highlighting, specify ``none``. For example:
This block of text would be styled with a background
and box, but with no syntax highlighting. | for the ``code-block`` directive, including ``c``, ``python``, and ``rst``, and also ``console``, ``bash``, or ``shell``. If you want no syntax highlighting, specify ``none``. For example:
This block of text would be styled with a background
and box, but with no syntax highlighting. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
b5a9305b-e164-477e-a33d-9f12342e6902 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 188 | opea-semantic-v1 | a31af740fc44f9fb | only one set of numbered steps is intended per document and the steps must be level 2 headings.
Documentation Generation
************************ | ai_ref_knowledge | OPEA Documentation | only one set of numbered steps is intended per document and the steps must be level 2 headings.
Documentation Generation
************************ | only one set of numbered steps is intended per document and the steps must be level 2 headings.
Documentation Generation
************************ | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
b734e2ff-1607-420c-a32c-1d7ce1c53e5f | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 92 | opea-semantic-v1 | 78efea28f757732d | markdown document is done using the reST ``:doc:`` role, and using the path to the markdown file leaving off the ``.md`` file extension. For example::
Refer to the :doc:`/GenAIExamples/supported_examples` list for details. | ai_ref_knowledge | OPEA Documentation | markdown document is done using the reST ``:doc:`` role, and using the path to the markdown file leaving off the ``.md`` file extension. For example::
Refer to the :doc:`/GenAIExamples/supported_examples` list for details. | markdown document is done using the reST ``:doc:`` role, and using the path to the markdown file leaving off the ``.md`` file extension. For example::
Refer to the :doc:`/GenAIExamples/supported_examples` list for details. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
b98124da-dbb7-4f18-b482-a8f020193a7a | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 122 | opea-semantic-v1 | d58cf706bda506d0 | if it finds a .md or .rst file that's not included in a toctree directive, it's best to us a .txt extension for included files::
.. include:: mdtable.txt | ai_ref_knowledge | OPEA Documentation | if it finds a .md or .rst file that's not included in a toctree directive, it's best to us a .txt extension for included files::
.. include:: mdtable.txt | if it finds a .md or .rst file that's not included in a toctree directive, it's best to us a .txt extension for included files::
.. include:: mdtable.txt | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
bf862e83-dbbe-45ca-b164-ad681710bde6 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 32 | opea-semantic-v1 | 302f189110434e49 | sign and a ``.`` as used in the first list item. Indent continuation lines with spaces to align with the text of first list item:
It's important to maintain the indentation of content under a list so in the
generated HTML, the content looks like it's part of that list and not a new
paragraph outside of that list. | ai_ref_knowledge | OPEA Documentation | sign and a ``.`` as used in the first list item. Indent continuation lines with spaces to align with the text of first list item:
It's important to maintain the indentation of content under a list so in the
generated HTML, the content looks like it's part of that list and not a new
paragraph outside of that list. | sign and a ``.`` as used in the first list item. Indent continuation lines with spaces to align with the text of first list item:
It's important to maintain the indentation of content under a list so in the
generated HTML, the content looks like it's part of that list and not a new
paragraph outside of that list. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
c11bb28c-2c62-444b-a0fe-56bffdf340b0 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 187 | opea-semantic-v1 | 2479533f7370962b | This is the second instruction step.
only one set of numbered steps is intended per document and the steps
must be level 2 headings. | ai_ref_knowledge | OPEA Documentation | This is the second instruction step.
only one set of numbered steps is intended per document and the steps
must be level 2 headings. | This is the second instruction step.
only one set of numbered steps is intended per document and the steps
must be level 2 headings. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
c15ff84b-7d20-4467-99c8-0c537447f336 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 93 | opea-semantic-v1 | c0ae5299f3f81e11 | Refer to the :doc:`/GenAIExamples/supported_examples` list for details.
Note that all the markdown files from all the repos are available with
this syntax because we copy all those files into the doc building folder
under a top-level directory with that repo's name. Markdown files in the
docs repo don't use the ``do... | ai_ref_knowledge | OPEA Documentation | Refer to the :doc:`/GenAIExamples/supported_examples` list for details.
Note that all the markdown files from all the repos are available with
this syntax because we copy all those files into the doc building folder
under a top-level directory with that repo's name. Markdown files in the
docs repo don't use the ``do... | Refer to the :doc:`/GenAIExamples/supported_examples` list for details.
Note that all the markdown files from all the repos are available with
this syntax because we copy all those files into the doc building folder
under a top-level directory with that repo's name. Markdown files in the
docs repo don't use the ``do... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
c1ac2bd4-9155-490e-8ab8-ef6f03d7bb17 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 24 | opea-semantic-v1 | 90819cf8d53cd9f7 | * two back quotes: ````text```` for ``inline code`` samples.
ReST rules for inline markup try to be forgiving to account for common
cases of using these marks. For example, using an asterisk to indicate
multiplication, such as ``2 * (x + y)`` will not be interpreted as an
unterminated italics section. | ai_ref_knowledge | OPEA Documentation | * two back quotes: ````text```` for ``inline code`` samples.
ReST rules for inline markup try to be forgiving to account for common
cases of using these marks. For example, using an asterisk to indicate
multiplication, such as ``2 * (x + y)`` will not be interpreted as an
unterminated italics section. | * two back quotes: ````text```` for ``inline code`` samples.
ReST rules for inline markup try to be forgiving to account for common
cases of using these marks. For example, using an asterisk to indicate
multiplication, such as ``2 * (x + y)`` will not be interpreted as an
unterminated italics section. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
c40d8b4d-0e09-4bd6-a3e0-dfe077e1a163 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 29 | opea-semantic-v1 | 9bc7f781c43d918f | Lists *****
For bullet lists, place an asterisk (``*``) or hyphen (``-``) at the start of
a paragraph and indent continuation lines with two spaces. | ai_ref_knowledge | OPEA Documentation | Lists *****
For bullet lists, place an asterisk (``*``) or hyphen (``-``) at the start of
a paragraph and indent continuation lines with two spaces. | Lists *****
For bullet lists, place an asterisk (``*``) or hyphen (``-``) at the start of
a paragraph and indent continuation lines with two spaces. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
c42ef77f-1c8e-4132-ac48-672d319db35e | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 179 | opea-semantic-v1 | d30929c5d77ab46f | This content will show on the macOS tab ::: :::{tab-item} Windows
This content will show on the Windows tab
:::
:::: | ai_ref_knowledge | OPEA Documentation | This content will show on the macOS tab ::: :::{tab-item} Windows
This content will show on the Windows tab
:::
:::: | This content will show on the macOS tab ::: :::{tab-item} Windows
This content will show on the Windows tab
:::
:::: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
c440d497-77ee-4fa8-963c-fdaef5e6efe1 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 160 | opea-semantic-v1 | e15c2733b940c1ab | .. group-tab:: reST
In reST, we've included the ``graphviz`` Sphinx extension to enable that
text description language to render drawings. For more information, see | ai_ref_knowledge | OPEA Documentation | .. group-tab:: reST
In reST, we've included the ``graphviz`` Sphinx extension to enable that
text description language to render drawings. For more information, see | .. group-tab:: reST
In reST, we've included the ``graphviz`` Sphinx extension to enable that
text description language to render drawings. For more information, see | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
c84c7dda-9240-4b22-b74d-4d95a7799c36 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 178 | opea-semantic-v1 | cb6664b8052fb3b1 | This content will show on the Linux tab ::: :::{tab-item} macOS
This content will show on the macOS tab
:::
:::{tab-item} Windows | ai_ref_knowledge | OPEA Documentation | This content will show on the Linux tab ::: :::{tab-item} macOS
This content will show on the macOS tab
:::
:::{tab-item} Windows | This content will show on the Linux tab ::: :::{tab-item} macOS
This content will show on the macOS tab
:::
:::{tab-item} Windows | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
cbe84e34-bcd1-49bb-b15c-3dfd24e25bcc | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 27 | opea-semantic-v1 | 8e06720360d8e837 | a space, so ``*this is italics*``, (*this is italics*) while ``* this isn't*`` (* this isn't*) because of that extra space after the first asterisk.
If an asterisk or back quote appears in running text and could be confused
with inline markup delimiters, you can eliminate the confusion by adding a
backslash (``\``) bef... | ai_ref_knowledge | OPEA Documentation | a space, so ``*this is italics*``, (*this is italics*) while ``* this isn't*`` (* this isn't*) because of that extra space after the first asterisk.
If an asterisk or back quote appears in running text and could be confused
with inline markup delimiters, you can eliminate the confusion by adding a
backslash (``\``) bef... | a space, so ``*this is italics*``, (*this is italics*) while ``* this isn't*`` (* this isn't*) because of that extra space after the first asterisk.
If an asterisk or back quote appears in running text and could be confused
with inline markup delimiters, you can eliminate the confusion by adding a
backslash (``\``) bef... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
cc3386da-235f-4896-920d-48a38528c4db | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 21 | opea-semantic-v1 | 573f53873279b3dd | Some more content
* There must be only one ``#`` H1 heading at the beginning of the document
indicating the document's title. * You must not skip heading levels on the way down in the document
hierarchy, e.g., do not go from a H1 ``#`` to an H3 ``###`` without an
intervening H2 ``##``. You may skip heading levels on... | ai_ref_knowledge | OPEA Documentation | Some more content
* There must be only one ``#`` H1 heading at the beginning of the document
indicating the document's title. * You must not skip heading levels on the way down in the document
hierarchy, e.g., do not go from a H1 ``#`` to an H3 ``###`` without an
intervening H2 ``##``. You may skip heading levels on... | Some more content
* There must be only one ``#`` H1 heading at the beginning of the document
indicating the document's title. * You must not skip heading levels on the way down in the document
hierarchy, e.g., do not go from a H1 ``#`` to an H3 ``###`` without an
intervening H2 ``##``. You may skip heading levels on... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
cc7b90a3-88ea-4d67-ad48-bbbcd135904e | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 184 | opea-semantic-v1 | b324e847888bf764 | it will be displayed as a numbered step, sequentially numbered within the document. (Second-level headings without this ``rst-class`` directive will not be numbered.) For example::
.. rst-class:: numbered-step | ai_ref_knowledge | OPEA Documentation | it will be displayed as a numbered step, sequentially numbered within the document. (Second-level headings without this ``rst-class`` directive will not be numbered.) For example::
.. rst-class:: numbered-step | it will be displayed as a numbered step, sequentially numbered within the document. (Second-level headings without this ``rst-class`` directive will not be numbered.) For example::
.. rst-class:: numbered-step | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
cee6924c-6990-4817-a0dd-e09b0e202fbc | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 36 | opea-semantic-v1 | 54535b35f8a06d57 | * Here's a second bullet list item
Notice how that middle paragraph is out-dented from the bullet list compared
with this next example where it's not (yes, it's subtle): | ai_ref_knowledge | OPEA Documentation | * Here's a second bullet list item
Notice how that middle paragraph is out-dented from the bullet list compared
with this next example where it's not (yes, it's subtle): | * Here's a second bullet list item
Notice how that middle paragraph is out-dented from the bullet list compared
with this next example where it's not (yes, it's subtle): | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
cf249664-f645-4c7c-a341-56cbca877f4b | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 63 | opea-semantic-v1 | 967d5d961e731ae2 | .. list-table:: Table title
* - Heading 1
- Heading 2
- Heading 3
* - body row 1, column 1
- body row 1, column 2
- body row 1, column 3
* - body row 2, column 1
- body row 2, column 2
- body row 2, column 3 | ai_ref_knowledge | OPEA Documentation | .. list-table:: Table title
* - Heading 1
- Heading 2
- Heading 3
* - body row 1, column 1
- body row 1, column 2
- body row 1, column 3
* - body row 2, column 1
- body row 2, column 2
- body row 2, column 3 | .. list-table:: Table title
* - Heading 1
- Heading 2
- Heading 3
* - body row 1, column 1
- body row 1, column 2
- body row 1, column 3
* - body row 2, column 1
- body row 2, column 2
- body row 2, column 3 | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
d0cdd5db-a16b-4c71-b989-9aa7e34a2acb | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 44 | opea-semantic-v1 | 1c7a39ec0dbeb8ae | #. This is an autonumbered list (default is to use numbers starting with 1).
#. This is a second-level list under the first item (also
autonumbered). Notice the indenting. #. And a second item in the nested list. #. And a second item back in the containing list. No blank line
needed, but it wouldn't hurt for readabil... | ai_ref_knowledge | OPEA Documentation | #. This is an autonumbered list (default is to use numbers starting with 1).
#. This is a second-level list under the first item (also
autonumbered). Notice the indenting. #. And a second item in the nested list. #. And a second item back in the containing list. No blank line
needed, but it wouldn't hurt for readabil... | #. This is an autonumbered list (default is to use numbers starting with 1).
#. This is a second-level list under the first item (also
autonumbered). Notice the indenting. #. And a second item in the nested list. #. And a second item back in the containing list. No blank line
needed, but it wouldn't hurt for readabil... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
d117bd4a-3c0c-4471-8c3a-115faef618a8 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 74 | opea-semantic-v1 | 7c5494355c444209 | MyST extends markdown by supporting additional inline markup elements (called "roles") used to tag text with special meanings and enable output formatting.
Branch-Specific File Links
************************** | ai_ref_knowledge | OPEA Documentation | MyST extends markdown by supporting additional inline markup elements (called "roles") used to tag text with special meanings and enable output formatting.
Branch-Specific File Links
************************** | MyST extends markdown by supporting additional inline markup elements (called "roles") used to tag text with special meanings and enable output formatting.
Branch-Specific File Links
************************** | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
d1f677fd-0f0c-4ec2-9041-f168d0d2b1ef | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 119 | opea-semantic-v1 | 9ca3ae2b988b2386 | \:start-after\: text Only the content after the first occurrence of the specified ``text`` in the external file will be included.
\:end-before\:
Only the content before the first occurrence of the specified ``text``
in the external file will be included. | ai_ref_knowledge | OPEA Documentation | \:start-after\: text Only the content after the first occurrence of the specified ``text`` in the external file will be included.
\:end-before\:
Only the content before the first occurrence of the specified ``text``
in the external file will be included. | \:start-after\: text Only the content after the first occurrence of the specified ``text`` in the external file will be included.
\:end-before\:
Only the content before the first occurrence of the specified ``text``
in the external file will be included. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
d2d7e85b-c318-43c7-8ca3-c387d11e6e4e | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 129 | opea-semantic-v1 | 2e1772e21da673d1 | You can include an external file and show it as if it were a codeblock by using the ``literalinclude`` directive::
```{literalinclude} relativepath/to/file | ai_ref_knowledge | OPEA Documentation | You can include an external file and show it as if it were a codeblock by using the ``literalinclude`` directive::
```{literalinclude} relativepath/to/file | You can include an external file and show it as if it were a codeblock by using the ``literalinclude`` directive::
```{literalinclude} relativepath/to/file | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
d3ead88c-d782-4eb4-a5ad-7e331edbf61e | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 152 | opea-semantic-v1 | eaa0394fd1875784 | Tabs, Spaces, and Indenting ***************************
Indenting is significant in reST file content, and using spaces is preferred. Extra indenting can (unintentionally) change the way content is rendered, too. For lists and directives, indent the content text to the first non-blank space
in the preceding line. For e... | ai_ref_knowledge | OPEA Documentation | Tabs, Spaces, and Indenting ***************************
Indenting is significant in reST file content, and using spaces is preferred. Extra indenting can (unintentionally) change the way content is rendered, too. For lists and directives, indent the content text to the first non-blank space
in the preceding line. For e... | Tabs, Spaces, and Indenting ***************************
Indenting is significant in reST file content, and using spaces is preferred. Extra indenting can (unintentionally) change the way content is rendered, too. For lists and directives, indent the content text to the first non-blank space
in the preceding line. For e... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
d4ce3a3b-79ff-46a2-b0aa-010f9ea665a6 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 107 | opea-semantic-v1 | c957666888991557 | .. literalinclude:: ../sphinx/substitutions.txt
We've kept the substitutions list small but you can add others as needed by
submitting a change to the ``substitutions.txt`` file. | ai_ref_knowledge | OPEA Documentation | .. literalinclude:: ../sphinx/substitutions.txt
We've kept the substitutions list small but you can add others as needed by
submitting a change to the ``substitutions.txt`` file. | .. literalinclude:: ../sphinx/substitutions.txt
We've kept the substitutions list small but you can add others as needed by
submitting a change to the ``substitutions.txt`` file. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
d8753497-bcde-4102-a31c-354df18af6c5 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 158 | opea-semantic-v1 | 9f5c6b7a2daff736 | Background Colors *****************
We've defined some CSS styles for use as background colors for paragraphs. These styles can be applied using the ``.. rst-class`` directive using one of
these style names. You can also use the defined ``centered`` style to place the
text centered within the element, useful for center... | ai_ref_knowledge | OPEA Documentation | Background Colors *****************
We've defined some CSS styles for use as background colors for paragraphs. These styles can be applied using the ``.. rst-class`` directive using one of
these style names. You can also use the defined ``centered`` style to place the
text centered within the element, useful for center... | Background Colors *****************
We've defined some CSS styles for use as background colors for paragraphs. These styles can be applied using the ``.. rst-class`` directive using one of
these style names. You can also use the defined ``centered`` style to place the
text centered within the element, useful for center... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
d8dc650b-0e57-4c52-bfc1-be1072824154 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 121 | opea-semantic-v1 | 7e3fdabce0c1f1fb | These and other options described in the `docutils include directive <https://docutils.sourceforge.io/docs/ref/rst/directives.html#including-an-external-document-fragment>`_ documentation.
As a practical example, here's how you could include markdown content into
a reST document, and have that included content interpr... | ai_ref_knowledge | OPEA Documentation | These and other options described in the `docutils include directive <https://docutils.sourceforge.io/docs/ref/rst/directives.html#including-an-external-document-fragment>`_ documentation.
As a practical example, here's how you could include markdown content into
a reST document, and have that included content interpr... | These and other options described in the `docutils include directive <https://docutils.sourceforge.io/docs/ref/rst/directives.html#including-an-external-document-fragment>`_ documentation.
As a practical example, here's how you could include markdown content into
a reST document, and have that included content interpr... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
d9c77515-65bd-4bb8-9194-e13af63fad82 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 26 | opea-semantic-v1 | 3f0ba6ba22c4db18 | * one back quote: ```text``` for ``inline code`` samples.
For inline markup, the characters between
the beginning and ending characters must not start or end with a space,
so ``*this is italics*``, (*this is italics*) while ``* this isn't*``
(* this isn't*) because of that extra space after the first asterisk. | ai_ref_knowledge | OPEA Documentation | * one back quote: ```text``` for ``inline code`` samples.
For inline markup, the characters between
the beginning and ending characters must not start or end with a space,
so ``*this is italics*``, (*this is italics*) while ``* this isn't*``
(* this isn't*) because of that extra space after the first asterisk. | * one back quote: ```text``` for ``inline code`` samples.
For inline markup, the characters between
the beginning and ending characters must not start or end with a space,
so ``*this is italics*``, (*this is italics*) while ``* this isn't*``
(* this isn't*) because of that extra space after the first asterisk. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
d9fda311-d076-4b31-a1b9-5c3748bc8e7c | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 186 | opea-semantic-v1 | 7237dd66fcd4b7cd | the heading to be a summary of what the step is (the step numbering is automated so you can move steps around easily if needed).
.. rst-class:: numbered-step | ai_ref_knowledge | OPEA Documentation | the heading to be a summary of what the step is (the step numbering is automated so you can move steps around easily if needed).
.. rst-class:: numbered-step | the heading to be a summary of what the step is (the step numbering is automated so you can move steps around easily if needed).
.. rst-class:: numbered-step | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
dbfce017-c6ac-4632-a61e-2a9e3c0e5881 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 68 | opea-semantic-v1 | 080e7f197199fc5e | each column's header, and use pipes ``|`` to separate each column. For compatibility you should also add a pipe on both ends of the row::
| heading 1 | heading 2 | heading 3 |
|---|---|---|
|row 1 column 1 | row 1 column 2 | yes, it's row 1 column 3|
|row 2 col 1 | row 2 column 2 | row 2 col 3 | | ai_ref_knowledge | OPEA Documentation | each column's header, and use pipes ``|`` to separate each column. For compatibility you should also add a pipe on both ends of the row::
| heading 1 | heading 2 | heading 3 |
|---|---|---|
|row 1 column 1 | row 1 column 2 | yes, it's row 1 column 3|
|row 2 col 1 | row 2 column 2 | row 2 col 3 | | each column's header, and use pipes ``|`` to separate each column. For compatibility you should also add a pipe on both ends of the row::
| heading 1 | heading 2 | heading 3 |
|---|---|---|
|row 1 column 1 | row 1 column 2 | yes, it's row 1 column 3|
|row 2 col 1 | row 2 column 2 | row 2 col 3 | | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
dec46992-9aed-42fa-b597-622634f96291 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 97 | opea-semantic-v1 | 60a914877a32792a | Refer to [Kubernetes deployment](./kubernetes/intel/README_gmc.md)
That reference is rendered as a reference to the README_gmc.html found in
the directory ``kubernetes/intel`` relative to the document doing the
linking. | ai_ref_knowledge | OPEA Documentation | Refer to [Kubernetes deployment](./kubernetes/intel/README_gmc.md)
That reference is rendered as a reference to the README_gmc.html found in
the directory ``kubernetes/intel`` relative to the document doing the
linking. | Refer to [Kubernetes deployment](./kubernetes/intel/README_gmc.md)
That reference is rendered as a reference to the README_gmc.html found in
the directory ``kubernetes/intel`` relative to the document doing the
linking. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
df0c0935-6684-4997-9b72-58cf0e2da632 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 39 | opea-semantic-v1 | 311e31287aff1dba | Here's a paragraph that does look like it's part of that first bullet list item's content because it's indented in the source.
* Here's a second bullet list item | ai_ref_knowledge | OPEA Documentation | Here's a paragraph that does look like it's part of that first bullet list item's content because it's indented in the source.
* Here's a second bullet list item | Here's a paragraph that does look like it's part of that first bullet list item's content because it's indented in the source.
* Here's a second bullet list item | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
df439134-ad1f-4942-8e78-4bb835c509b8 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 88 | opea-semantic-v1 | e11d5f61dc5183c0 | easy cross-page linking within the site, each file should have a reference label before its title so that it can be referenced from another file.
names such as "samples" or "introduction" should be avoided. | ai_ref_knowledge | OPEA Documentation | easy cross-page linking within the site, each file should have a reference label before its title so that it can be referenced from another file.
names such as "samples" or "introduction" should be avoided. | easy cross-page linking within the site, each file should have a reference label before its title so that it can be referenced from another file.
names such as "samples" or "introduction" should be avoided. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
df6839eb-f9c0-4e24-aa0e-aa1f732fdfa7 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 95 | opea-semantic-v1 | 89c8b691161f062a | .. group-tab:: markdown
Markdown supports linking to other documents using the ``[link text](link path)``. For example to link to a document within the same repo, a relative path is
used:: | ai_ref_knowledge | OPEA Documentation | .. group-tab:: markdown
Markdown supports linking to other documents using the ``[link text](link path)``. For example to link to a document within the same repo, a relative path is
used:: | .. group-tab:: markdown
Markdown supports linking to other documents using the ``[link text](link path)``. For example to link to a document within the same repo, a relative path is
used:: | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
e151a093-2e11-40ec-8a6f-fd84b162392b | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 75 | opea-semantic-v1 | 979477abf3c34a49 | Branch-Specific File Links **************************
You can add a link in the documentation to a specific file in the GitHub tree. Be sure the link points to the branch for that version of the documentation. For
example, links in the v0.8 release of the documentation should be to files in
the v0.8 branch. Do not link... | ai_ref_knowledge | OPEA Documentation | Branch-Specific File Links **************************
You can add a link in the documentation to a specific file in the GitHub tree. Be sure the link points to the branch for that version of the documentation. For
example, links in the v0.8 release of the documentation should be to files in
the v0.8 branch. Do not link... | Branch-Specific File Links **************************
You can add a link in the documentation to a specific file in the GitHub tree. Be sure the link points to the branch for that version of the documentation. For
example, links in the v0.8 release of the documentation should be to files in
the v0.8 branch. Do not link... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
e2eb7054-9d19-4563-86aa-3fb7ae055e21 | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 83 | opea-semantic-v1 | 44ab7ab5cfb47c5a | indicates an **outbound link**. In this example, the label was added immediately before a heading, so the text that's displayed is the heading text itself.
With Sphinx, we can create link-references to any tagged text within
the project documentation. | ai_ref_knowledge | OPEA Documentation | indicates an **outbound link**. In this example, the label was added immediately before a heading, so the text that's displayed is the heading text itself.
With Sphinx, we can create link-references to any tagged text within
the project documentation. | indicates an **outbound link**. In this example, the label was added immediately before a heading, so the text that's displayed is the heading text itself.
With Sphinx, we can create link-references to any tagged text within
the project documentation. | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
e321539d-7247-4bbd-9741-ee04be43ffcb | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 136 | opea-semantic-v1 | 529832e6860c5a69 | This example would render as:
struct _k_object {
char *name;
u8_t perms[CONFIG_MAX_THREAD_BYTES];
u8_t type;
u8_t flags;
u32_t data;
} __packed; | ai_ref_knowledge | OPEA Documentation | This example would render as:
struct _k_object {
char *name;
u8_t perms[CONFIG_MAX_THREAD_BYTES];
u8_t type;
u8_t flags;
u32_t data;
} __packed; | This example would render as:
struct _k_object {
char *name;
u8_t perms[CONFIG_MAX_THREAD_BYTES];
u8_t type;
u8_t flags;
u32_t data;
} __packed; | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation | |
e3bfb68c-4b88-46c8-ba74-ba9fe4d5c7ca | OPEA Documentation | file://datasets/opea-docs/developer-guides/doc_guidelines.rst | unknown | 2984c7e3-9a40-4ae0-99eb-93b080b9a51d | 67 | opea-semantic-v1 | 4c33c9d3681b03cd | .. group-tab:: markdown
Markdown also supports a more free-form table syntax where the rigid box
alignment is greatly simplified as explained in
`markdown tables <https://www.markdownguide.org/extended-syntax/#tables>`_. Use three or more hyphens ``---`` to denote each column's header, and use
pipes ``|`` to separat... | ai_ref_knowledge | OPEA Documentation | .. group-tab:: markdown
Markdown also supports a more free-form table syntax where the rigid box
alignment is greatly simplified as explained in
`markdown tables <https://www.markdownguide.org/extended-syntax/#tables>`_. Use three or more hyphens ``---`` to denote each column's header, and use
pipes ``|`` to separat... | .. group-tab:: markdown
Markdown also supports a more free-form table syntax where the rigid box
alignment is greatly simplified as explained in
`markdown tables <https://www.markdownguide.org/extended-syntax/#tables>`_. Use three or more hyphens ``---`` to denote each column's header, and use
pipes ``|`` to separat... | opea, enterprise-ai, genai, docs, P1 | OPEA Documentation |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.