Переглянути джерело

doc: update doc/README.md and genwiki

KernelDeimos 2 місяців тому
батько
коміт
2a7bd2ad8d
2 змінених файлів з 8 додано та 0 видалено
  1. 5 0
      doc/README.md
  2. 3 0
      tools/genwiki/main.js

+ 5 - 0
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),

+ 3 - 0
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, '')