-
Notifications
You must be signed in to change notification settings - Fork 88
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
Add a wiki page #111
Comments
Thanks you Shreyas,
The idea here is to keep the focus on important things that would make the project as less time consuming as possible, maintaining a wiki page could become a huge work if you have to add documentation about more than 1000 settings, and i even did mention the updates it needs over time... So short answer:
Any way there are already some wiki sections in the main readme page, if we just add some question/answer on the github wiki that would be enough for the current situation. Let me know what you are planning to do :) |
initial wiki introduced here https://github.com/intika/Librefox/wiki i will update/add content later on, a task for it is added here #3 ;) |
Could we move documentation for the rules in
mozilla.cfg
out of the file and instead use eitherdocs/rules
with markdown files or Github's wiki feature (I personally prefer the former)? This would make going through the rules much easier. Permalinking to a certain Librefox-modified rule's documentation would be easier. Scrolling through themozilla.cfg
when you're looking for something specific would be easier. It would be easy to later use the markdown docs to generate html docs for use on the website. Besides separation of concerns is usually a good thing anyway.I could work on this if approved.
Edit: Here's an example — https://gist.github.com/shreyasminocha/d197ce3f4a8c7bc6ecdf64d34d121f37
The text was updated successfully, but these errors were encountered: