diff --git a/README.md b/README.md deleted file mode 100644 index 7d15f58..0000000 Binary files a/README.md and /dev/null differ 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