From 2796c36a559694206e218506dc344443cc0d9248 Mon Sep 17 00:00:00 2001 From: Paul Dee Date: Fri, 17 Mar 2023 04:05:16 +0100 Subject: [PATCH] DOCS: Fixes to the add rtype procedures (#2187) Co-authored-by: Tom Limoncelli --- documentation/adding-new-rtypes.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/documentation/adding-new-rtypes.md b/documentation/adding-new-rtypes.md index 3c25d31db..1889035a8 100644 --- a/documentation/adding-new-rtypes.md +++ b/documentation/adding-new-rtypes.md @@ -251,3 +251,32 @@ Add a new Markdown file to `documentation/functions/domain`. Copy an existing fi - `parameter_types`: an object with parameter names as keys and TypeScript type names as values. Check out existing record documentation if you’re not sure to put for a parameter. Note that this isn’t displayed on the website, it’s only used to generate the `.d.ts` file. The rest of the file is the documentation. You can use Markdown syntax to format the text. + +Add the new file `FOO.md` to the documentation table of contents [`documentation/SUMMARY.md`](SUMMARY.md#domain-modifiers), and/or to the [`Service Provider specific`](SUMMARY.md#service-provider-specific) section if you made a record specific to a provider, and to the [`Record Modifiers`](SUMMARY.md#record-modifiers) section if you created any `*_BUILDER` or `*_HELPER` or similar functions for the new record type: + +{% code title="documentation/SUMMARY.md" %} +```diff +... +* Domain Modifiers +... + * [DnsProvider](functions/domain/DnsProvider.md) ++ * [FOO](functions/domain/FOO.md) + * [FRAME](functions/domain/FRAME.md) +... + * Service Provider specific +... + * ClouDNS + * [CLOUDNS_WR](functions/domain/CLOUDNS_WR.md) ++ * ASDF ++ * [NINJA_RECORD](function/domain/FOO_NINJA.md) + * NS1 + * [NS1_URLFWD](functions/domain/NS1_URLFWD.md) +... +* Record Modifiers +... + * [DMARC_BUILDER](functions/record/DMARC_BUILDER.md) ++ * [FOO_HELPER](functions/record/FOO_HELPER.md) + * [SPF_BUILDER](functions/record/SPF_BUILDER.md) +... +``` +{% endcode %}