From 51e570ec5a993f65b0bb1ece804d2e035b4f43c9 Mon Sep 17 00:00:00 2001 From: Tana M Berry Date: Mon, 14 Aug 2023 13:51:56 -0500 Subject: [PATCH] website/docs: new reference template (#6527) * new reference template * typos * tweak --------- Co-authored-by: Tana Berry --- .../docs/templates/reference.md | 31 +++++++++++++++++++ website/sidebarsDev.js | 1 + 2 files changed, 32 insertions(+) create mode 100644 website/developer-docs/docs/templates/reference.md diff --git a/website/developer-docs/docs/templates/reference.md b/website/developer-docs/docs/templates/reference.md new file mode 100644 index 000000000..50aaf4d85 --- /dev/null +++ b/website/developer-docs/docs/templates/reference.md @@ -0,0 +1,31 @@ +--- +title: "Reference topic" +--- + +Create a title that specifies the component you are documenting. For example, "Group attributes". + +Reference documentation provides details, values, syntax, etc., about specific programming elements. + +The most common type of reference documentation is for REST APIs; the request syntax, a successful response, any parameters such as query, header, or request body parameters, and possible http status codes. + +Other types of reference content include lists of functions, parameters, event actions, and attributes. + +## Overview + +Provide a sentence or two about the topic. + +## Head 2 + +Use a title that is descriptive, such as "User object attributes" or "Expression policy functions". + +Use tables, bullet lists, Head3s... whatever you need to clearly present the values. + +Be sure to use a sentence after every heading, to explain what the section is about, how the values are used, etc. + +## Head 3 (optional, if needed) + +Add a sentence explaining the following grouping. + +## Head 3 (optional, if needed) + +Add a sentence explaining the following grouping. diff --git a/website/sidebarsDev.js b/website/sidebarsDev.js index 30cbe3922..4cb528c34 100644 --- a/website/sidebarsDev.js +++ b/website/sidebarsDev.js @@ -72,6 +72,7 @@ module.exports = { items: [ "docs/templates/procedural", "docs/templates/conceptual", + "docs/templates/reference", ], }, ],