From 2a7bd2ad8df68d81d75db4982229bd30ba6b256f Mon Sep 17 00:00:00 2001 From: KernelDeimos Date: Tue, 25 Feb 2025 15:23:58 -0500 Subject: [PATCH] doc: update doc/README.md and genwiki --- doc/README.md | 5 +++++ tools/genwiki/main.js | 3 +++ 2 files changed, 8 insertions(+) diff --git a/doc/README.md b/doc/README.md index 586e2f576..3e0d75119 100644 --- a/doc/README.md +++ b/doc/README.md @@ -1,5 +1,10 @@ # Puter Documentation +Hi, you've found Puter's wiki page on GitHub! If you were looking for +something else, you might find it in the links below. +All of the wiki docs are generated from `doc/` directories in the main +repository, so it's best to edit docs there rather than here. + ## Users If you have general questions about using [Puter](https://puter.com), diff --git a/tools/genwiki/main.js b/tools/genwiki/main.js index 6c743ad77..7800c0f9b 100644 --- a/tools/genwiki/main.js +++ b/tools/genwiki/main.js @@ -29,6 +29,9 @@ const ROOT_DIR = path_.join(__dirname, '../..'); const WIKI_DIR = path_.join(__dirname, '../../submodules/wiki'); const path_to_name = path => { + // Special case for Home.md + if ( path === 'doc/README.md' ) return 'Home'; + // Remove src/ and doc/ components // path = path.replace(/src\//g, '') path = path.replace(/doc\//g, '')