Docs and wiki prep#645
Conversation
…ub Wiki - I deconstructed the original README.md into a new `docs/` directory with a more organized file structure (index, installation, library usage, CLI usage, building, known limitations, contributing, license). - I updated the root README.md to be a concise overview, linking to the detailed documentation in `docs/` and a future GitHub Wiki. - I created a `wiki_content/` directory containing markdown files corresponding to the content in `docs/`. - I adapted internal links in `wiki_content/` files to GitHub Wiki syntax (e.g., [[Page Name]]). - I added a `wiki_content/_Sidebar.md` file to suggest a navigation structure for the GitHub Wiki. - Note: A planned comprehensive update to `docs/library_usage.md` based on deep codebase analysis was only partially completed due to limitations I encountered for extensive multi-part file edits in a single operation.
|
i have used ai to make documentation for it. please have look and merge it if you find it usefull |
|
Hi! I took a look at it, and it doesn't seem to be ideal. The phrasing is good, but the content is meh; and the code snippets are outdated (like, very outdated). Since you are a starter, did you find it useful? |
Refactor documentation into docs/ folder and prepare content for GitH… as you can see i used jule and ask it to Read Lib and make documentations. If you can guide me where are those args and code i can make documentation manully by the way thanks for this amazing project. |
|
I really appreciate your commitment, and I agree the documentation is lacking and it's hard for a starter to, well, get started. When I first started this projects, thing evolved pretty fast and, you know, writing documentation is not attractive 😭 |
2 participants
No description provided.