From c901c7b6d6827fed8628a9dec0512b9923af1d88 Mon Sep 17 00:00:00 2001 From: perennial Date: Mon, 14 Oct 2024 15:39:17 +1100 Subject: [PATCH] docs: tidy headings --- doc/dev/feature-ideas.md | 2 +- doc/dev/features/exponential_backoff.md | 2 +- doc/dev/helpful-resources.md | 2 +- mkdocs.yml | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/dev/feature-ideas.md b/doc/dev/feature-ideas.md index 6968f60..f1f2d59 100644 --- a/doc/dev/feature-ideas.md +++ b/doc/dev/feature-ideas.md @@ -1,4 +1,4 @@ -# Proposals +# Feature ideas This section contains some potential features or redesigns that can be implemented into PixivFE. diff --git a/doc/dev/features/exponential_backoff.md b/doc/dev/features/exponential_backoff.md index ae5cdfa..7b5b2ac 100644 --- a/doc/dev/features/exponential_backoff.md +++ b/doc/dev/features/exponential_backoff.md @@ -1,4 +1,4 @@ -# Exponential Backoff in PixivFE +# Exponential backoff PixivFE implements exponential backoff as a strategy for handling API request failures and managing token usage. This document outlines the implementation details of this feature across two key components of the application. diff --git a/doc/dev/helpful-resources.md b/doc/dev/helpful-resources.md index a50616f..194cde5 100644 --- a/doc/dev/helpful-resources.md +++ b/doc/dev/helpful-resources.md @@ -1,4 +1,4 @@ -# Reference Material +# Helpful resources This section contains multiple external links to materials/resources that could help. diff --git a/mkdocs.yml b/mkdocs.yml index 81be3d4..c24dfa7 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -23,7 +23,7 @@ nav: - "Roadmap": "dev/roadmap.md" - "Testing": "dev/testing.md" - "Features": - - "Exponential backoff in PixivFE": "dev/features/exponential_backoff.md" + - "Exponential backoff": "dev/features/exponential_backoff.md" - "Caching": "dev/features/caching.md" - "Novels": "dev/features/novels.md" - "Tracing flamegraph": "dev/features/tracing-flamegraph.md"