In-platform custom documentation（平台内自定义文档）¶
You can create, publish, and manage custom documentation hosted on the Palantir platform with a documentation code repository. These "custom docs" can be indexed by AIP Assist, enabling AIP Assist to answer queries using your organization's documentation.
You can access custom documentation in the following ways:
- From the application launcher
- If custom documentation currently exists in your workspace, through the ? help icon on the left sidebar.
- Directly with your enrollment documentation URL:
https://<your-enrollment>/workspace/documentation/
See the section below for details on how to configure the title of the in-platform documentation application in your enrollment.
Note that the in-platform documentation application may include core documentation pages published by default that do not come from a custom documentation repository (for example, information on installing SAP connectors in data integrations).
In-platform documentation application title¶
The title of your custom documentation application is based on the Palantir platform title configured in Control Panel. For example, if your platform title is ABC, the application title will be ABC documentation. The platform title can be set in Control Panel in the Platform experience settings. If no platform title is set in Control Panel, or if it is set to Palantir, the custom documentation application title will default to Custom documentation.
Code Repositories documentation template¶
Palantir's in-platform custom documentation uses a special documentation template in Code Repositories. This documentation template requires a specific organization of files to enable discovery and publishing by the custom documentation service. In-platform custom documentation pages are written in Markdown with a few important differences from standard Markdown.
Get started with creating a new documentation repository.
中文翻译¶
平台内自定义文档¶
您可以通过文档代码仓库在 Palantir 平台上创建、发布和管理托管于平台内的自定义文档。这些"自定义文档"可被 AIP Assist 索引，使 AIP Assist 能够利用您组织的文档来回答查询。
您可以通过以下方式访问自定义文档：
- 从应用程序启动器
- 如果工作区中已存在自定义文档，可通过左侧边栏的 ? 帮助图标访问
- 直接使用您的注册文档 URL：
https://<your-enrollment>/workspace/documentation/
有关如何在注册中配置平台内文档应用程序标题的详细信息，请参阅下方章节。
请注意，平台内文档应用程序可能包含默认发布的、并非来自自定义文档仓库的核心文档页面（例如，数据集成中安装 SAP 连接器的相关信息）。
平台内文档应用程序标题¶
自定义文档应用程序的标题基于控制面板中配置的 Palantir 平台标题。例如，如果您的平台标题为 ABC，则应用程序标题将为 ABC documentation。平台标题可在控制面板的平台体验设置中进行配置。如果控制面板中未设置平台标题，或将其设置为 Palantir，则自定义文档应用程序标题将默认为 Custom documentation。
代码仓库文档模板¶
Palantir 的平台内自定义文档使用代码仓库中的特殊文档模板。该文档模板要求特定的文件组织结构，以便自定义文档服务能够发现并发布内容。平台内自定义文档页面使用 Markdown 编写，但与标准 Markdown 存在一些重要差异。