-
Notifications
You must be signed in to change notification settings - Fork 2.8k
[feat]: enhance wiki generation to include module READMEs #1289
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Hi, thanks for submitting this PR - that was pretty quick! I'm going to review this tomorrow. If you're able to set the indentation back to what it was before (4 spaces) that will make this a little easier to review. Generally I prefer indentation changes to be separate, and then we also need an explanation as to why (ex: other files using this convention). I assume in this case it's just an editor thing, and hopefully we'll fix inconsistencies like this by adding proper editor configs (btw are you using vscode or something else? I want to know why this happens for most contributors; I think I disabled that feature a long time ago) |
Thanks for the feedback. |
Hi, thanks for the update. There are still too many formatting changes at the moment, but I reviewed the code and the approach looks good. |
@KernelDeimos If you can list me all the formatting changes that need to be fixed (like earlier you mentioned keeping indentation to 4 spaces). I can update accordingly. |
You can see all the formatting changes under the "files changed" tab. If a line of code is not functionally changed, the formatting shouldn't be changed (it can be changed in a separate style-only PR) |
I understand what you’ve mentioned. This PR was primarily meant for code modifications, not just formatting changes. However, some formatting updates got included later on because my vs code auto-formatted the code due to the Prettier extension. I’ll make sure to keep formatting and functional changes in separate pull requests in future. Thanks for the guidance! |
Looking at the wiki diff after running the tool, I'm noticing there were previously README.md files inside miscellaneous doc dirs as well, and these are now removed. diff --git a/_Sidebar.md b/_Sidebar.md
index 809790c..712f581 100644
--- a/_Sidebar.md
+++ b/_Sidebar.md
@@ -1,13 +1,13 @@
## General
* [Home](Home)
+* [Index (README.md)](README)
* [Documentation for Robots](AI)
* [Meta Documentation](docmeta)
* [Puter in Production](prod)
* [Testing with Email](testing_with_email)
## API
-* [Index (README.md)](api-README)
* [api drivers](api-drivers)
* [Group Endpoints](api-group)
* [Notification Endpoints](api-notifications)
@@ -29,13 +29,100 @@
* [Repository Structure and Tooling](contributors-structure)
### Extensions
-* [Index (README.md)](contributors-extensions-README)
* [contributors extensions definitions](contributors-extensions-definitions)
* [contributors extensions events](contributors-extensions-events)
## Devmeta
* [Track Comments](devmeta-track_comments) |
What does this PR do?
This PR enhances the wiki generation script to improve inclusion, structure, and clarity of documentation for module-level content. It:
README.md
files in modules"Modules"
section in the sidebar"Module: "
prefix to titles for claritydoc/
filesFixes #1288
Summary of Changes
File Selection
README.md
files from all module directories (excluding paths inFILE_EXCLUDES
)Path Naming
module-path-to-module
ensure uniquenessTitle Generation
"Module: "
for module README filesSidebar Updates
Special Case Handling
"Modules"
toformat_name()
special formatting logicHow to Test
doc/
content is presentREADME.md
files are included under"Modules"
"Module: "
appear correctlyType of Change
Mandatory Tasks
Checklist