From 25f0744efd0981e0c237cf05125cfed75c0e8a71 Mon Sep 17 00:00:00 2001 From: davidstula Date: Sat, 19 Sep 2026 19:02:04 +0200 Subject: [PATCH] Changed index.md to README.md so that the docs home page also serves as the repo readme. --- README.md | Bin 102 -> 0 bytes docs/{index.md => README.md} | 2 +- docs/stack.md | 2 +- mkdocs.yml | 2 +- 4 files changed, 3 insertions(+), 3 deletions(-) delete mode 100644 README.md rename docs/{index.md => README.md} (99%) diff --git a/README.md b/README.md deleted file mode 100644 index 7d15f58d11cb29fae0eda6b5e0404d3f2cb7fbaf..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 102 zcmezWPnki1!G$58A(^2V$ns@K1hO(1G8yt1QW>nkB9$mA62a=6fjUxvDij!UfMg;= c5l}ryPdZSf0LaT{$O4KdGn6p!GH@{f00pQLl>h($ diff --git a/docs/index.md b/docs/README.md similarity index 99% rename from docs/index.md rename to docs/README.md index ba3f894..cd89f38 100644 --- a/docs/index.md +++ b/docs/README.md @@ -29,7 +29,7 @@ Run all commands from the repository root. The commands below use PowerShell. 1. Install the AI review dependency: ```npm ci --prefix .github/ai-review``` 1. Create an _.env_ file in the repository root with your own API key and model: - ```dotenv + ``` OPENAI_API_KEY=your-api-key OPENAI_MODEL=your-model-id ``` diff --git a/docs/stack.md b/docs/stack.md index 2710da0..9394eab 100644 --- a/docs/stack.md +++ b/docs/stack.md @@ -1,6 +1,6 @@ # My Docs as Code stack -This page details the tools used in the pipeline and my reasoning for choosing those tools. For details about the pipeline itself, see [the home page](index.md). +This page details the tools used in the pipeline and my reasoning for choosing those tools. For details about the pipeline itself, see [the home page](README.md). ## Authoring diff --git a/mkdocs.yml b/mkdocs.yml index a1c8f85..fe7732c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,4 +1,4 @@ site_name: Docs Machine nav: - - Home: index.md + - Home: README.md - Stack: stack.md \ No newline at end of file