Skip to content

Include module README.md files in wiki generation #1288

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.

Sign up for GitHub

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

Jump to bottom
Open
KernelDeimos opened this issue May 28, 2025 · 2 comments · May be fixed by #1289
Open

Include module README.md files in wiki generation #1288

KernelDeimos opened this issue May 28, 2025 · 2 comments · May be fixed by #1289

Comments

@KernelDeimos
Copy link
Contributor

The script at tools/genwiki/main.js uses the file walked to traverse markdown files which have a parent directory named doc and add then to the wiki (included in the repo as a git submodule). However, Puter modules also have a README.md file in their directories which would be a nice addition to the wiki as well. The task of this issue is to update wiki generation to include these files in a way that's intuitive when someone is navigating the wiki.
@KernelDeimos
Copy link
Contributor Author

@TanCodeX

@TanCodeX
Copy link
Contributor

Love to work on this. Thank you!

@TanCodeX TanCodeX linked a pull request May 29, 2025 that will close this issue
Open
20 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[feat]: enhance wiki generation to include module READMEs TanCodeX/puter
2 participants
@KernelDeimos @TanCodeX