Skip to content
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

Add a wiki page #111

Closed
shreyasminocha opened this issue Jan 29, 2019 · 2 comments
Closed

Add a wiki page #111

shreyasminocha opened this issue Jan 29, 2019 · 2 comments
Labels
to-do (approved) Next release to-do

Comments

@shreyasminocha
Copy link
Contributor

shreyasminocha commented Jan 29, 2019

Could we move documentation for the rules in mozilla.cfg out of the file and instead use either docs/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 the mozilla.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

@intika
Copy link
Owner

intika commented Jan 29, 2019

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:

  • A wiki ? yes sure that would be amazing
  • What would be the content ?
    -- Answer to important questions already asked and answered (closed issues)
    -- Some important cfg settings (not more than 50) like cookies etc.
    -- May be a list of privacy settings that break something.

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 :)

@intika intika changed the title Move docs out of mozilla.cfg Adding a wiki page Jan 29, 2019
@intika intika added the to-do (approved) Next release to-do label Jan 29, 2019
@intika intika changed the title Adding a wiki page Add a wiki page Jan 29, 2019
@intika
Copy link
Owner

intika commented Jan 30, 2019

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 ;)

@intika intika closed this as completed Jan 30, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
to-do (approved) Next release to-do
Projects
None yet
Development

No branches or pull requests

2 participants