Skip to content

Fix typo in Schema Document Processor overview #11005

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
smartcaveman wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix typo in Schema Document Processor overview #11005

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/spec/sdp_design_spec.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Schema Document Processor
====================================

## 1. Overview
DocFX supports different [document processors](../tutorial/howto_build_your_own_type_of_documentation_with_custom_plug-in.md) to handle different kinds of input. With a new data model introduced in, a new document processor is required to support that model, even most of the code logic is the same for these processors. With this situation considered, a Schema Document Processor (abbreviated to *SDP* below) is introduced to simplify the process. Togethor with a well defined [DocFX Document Schema](docfx_document_schema.md), SDP is able to *validate* and *process* a new data model with no extra effort needed.
DocFX supports different [document processors](../tutorial/howto_build_your_own_type_of_documentation_with_custom_plug-in.md) to handle different kinds of input. With a new data model introduced in, a new document processor is required to support that model, even most of the code logic is the same for these processors. With this situation considered, a Schema Document Processor (abbreviated to *SDP* below) is introduced to simplify the process. Together with a well defined [DocFX Document Schema](docfx_document_schema.md), SDP is able to *validate* and *process* a new data model with no extra effort needed.

## 2. Workflow
The workflow for SDP is illustrated below. In general, the schema file, with suggested naming convention, has `documentType` in its name, as `{documentType}`.schema.json (When `title` is defined in the schema file, `title` is considered as the `documentType` for this schema). `docfx` loads the schema files from `schemas` subfolder in `template` folder, and creates processors for these schema files with per schema file per processor. With data models are processed, `docfx` applies templates for that `documentType` to these data model, as details illustrated in [Template Introduction](../tutorial/intro_template.md#naming-rule-for-a-renderer-file) and generates output documentation.
Expand Down