From d8db3b87acecc7e974e080ea05c342eba827298e Mon Sep 17 00:00:00 2001 From: "Celina G. Val" Date: Tue, 5 Dec 2023 13:28:53 -0800 Subject: [PATCH] Fix StableMIR migration documentation (#2915) Rename the file to use '-' instead of `_` and add the new page to the index. Fixed version can be seen here: https://celinval.github.io/kani-dev/stable-mir.html --- docs/src/SUMMARY.md | 1 + docs/src/dev-documentation.md | 2 +- docs/src/{stable_mir.md => stable-mir.md} | 0 3 files changed, 2 insertions(+), 1 deletion(-) rename docs/src/{stable_mir.md => stable-mir.md} (100%) diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index d4609a87c23b..69be21a07ff5 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -26,6 +26,7 @@ - [Coding conventions](./conventions.md) - [Working with CBMC](./cbmc-hacks.md) - [Working with `rustc`](./rustc-hacks.md) + - [Migrating to StableMIR](./stable-mir.md) - [Command cheat sheets](./cheat-sheets.md) - [cargo kani assess](./dev-assess.md) - [Testing](./testing.md) diff --git a/docs/src/dev-documentation.md b/docs/src/dev-documentation.md index 173588586a3a..c3fe857cf0b6 100644 --- a/docs/src/dev-documentation.md +++ b/docs/src/dev-documentation.md @@ -14,7 +14,7 @@ developers (including external contributors): 3. [Development setup recommendations for working with `cbmc`](./cbmc-hacks.md). 4. [Development setup recommendations for working with `rustc`](./rustc-hacks.md). 5. [Guide for testing in Kani](./testing.md). - 6. [Transition to StableMIR](./stable_mir.md). + 6. [Transition to StableMIR](./stable-mir.md). > **NOTE**: The developer documentation is intended for Kani developers and not users. At present, the project is under heavy development and some items diff --git a/docs/src/stable_mir.md b/docs/src/stable-mir.md similarity index 100% rename from docs/src/stable_mir.md rename to docs/src/stable-mir.md