From 15413bada6d5cbf62a62872a5f764e31ec1fe67f Mon Sep 17 00:00:00 2001 From: aviau Date: Thu, 15 Aug 2024 17:58:54 -0400 Subject: [PATCH] split intro and concepts --- .../authentication.mdx | 0 docs/{introduction => concepts}/errors.mdx | 0 docs/concepts/getting-started.mdx | 49 +++++++++++++++++++ docs/{introduction => concepts}/paging.mdx | 0 .../rate-limits.mdx | 0 docs/concepts/sdk.mdx | 3 ++ docs/mint.json | 15 ++++-- 7 files changed, 62 insertions(+), 5 deletions(-) rename docs/{introduction => concepts}/authentication.mdx (100%) rename docs/{introduction => concepts}/errors.mdx (100%) create mode 100644 docs/concepts/getting-started.mdx rename docs/{introduction => concepts}/paging.mdx (100%) rename docs/{introduction => concepts}/rate-limits.mdx (100%) create mode 100644 docs/concepts/sdk.mdx diff --git a/docs/introduction/authentication.mdx b/docs/concepts/authentication.mdx similarity index 100% rename from docs/introduction/authentication.mdx rename to docs/concepts/authentication.mdx diff --git a/docs/introduction/errors.mdx b/docs/concepts/errors.mdx similarity index 100% rename from docs/introduction/errors.mdx rename to docs/concepts/errors.mdx diff --git a/docs/concepts/getting-started.mdx b/docs/concepts/getting-started.mdx new file mode 100644 index 0000000..06f184b --- /dev/null +++ b/docs/concepts/getting-started.mdx @@ -0,0 +1,49 @@ +--- +title: 'Getting Started' +--- + +The Flare API can be used to access Flare's search capabilities, configure monitoring, export events, and more. + +## Concepts + + + + + Create an API Key and obtain API tokens. + + + + Learn about the Flare API's rate limits. + + + + Learn about Flare's standard `from` request parameter and `next` response field. + + + + +## Guides + + + + + Export or search within all events associated within your tenant. + + + + Export all of Flare's leaked credentials for a given domain. + + + + Search in all of Flare's events using the Search API. + + + + +## API Reference + + + + View the full API reference. + + diff --git a/docs/introduction/paging.mdx b/docs/concepts/paging.mdx similarity index 100% rename from docs/introduction/paging.mdx rename to docs/concepts/paging.mdx diff --git a/docs/introduction/rate-limits.mdx b/docs/concepts/rate-limits.mdx similarity index 100% rename from docs/introduction/rate-limits.mdx rename to docs/concepts/rate-limits.mdx diff --git a/docs/concepts/sdk.mdx b/docs/concepts/sdk.mdx new file mode 100644 index 0000000..51ca7b4 --- /dev/null +++ b/docs/concepts/sdk.mdx @@ -0,0 +1,3 @@ +--- +title: "Python SDK" +--- diff --git a/docs/mint.json b/docs/mint.json index ab8193a..a8f0a6b 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -80,11 +80,16 @@ { "group": "Introduction", "pages": [ - "introduction/getting-started", - "introduction/authentication", - "introduction/rate-limits", - "introduction/errors", - "introduction/paging" + "introduction/getting-started" + ] + }, + { + "group": "Concepts", + "pages": [ + "concepts/authentication", + "concepts/rate-limits", + "concepts/errors", + "concepts/paging" ] }, {