uazo / cromite

Cromite a Bromite fork with ad blocking and privacy enhancements; take back your browser!
https://www.cromite.org/
GNU General Public License v3.0
2.96k stars 67 forks source link

Improving the documentation #1273

Open uazo opened 1 week ago

uazo commented 1 week ago

follow up from https://github.com/uazo/cromite/issues/1237#issuecomment-2187034203

@Retold3202 I found a way.

I would need you to read the headers of each patch, telling me what you do not understand, so that it can be edited to make it understandable. In the meantime, insert some metadata, such as a sort of category and the commit in which it was introduced, always within the header, so that we can exploit https://github.com/uazo/cromite/blob/master/docs/PATCHES.md which is automatically generated

let's talk about it

Retold3202 commented 1 week ago

Sounds good, I'll start working on the metadata to the best of my ability, & I'll start reading through the patches and make a list of what I don't understand.

a sort of category

I like this idea, categories would be nice for organization. I'm currently envisioning the following 3 categories as a starting point:

Of course this could be changed at any time, & any categories could be added, removed, or renamed (Ex. Maybe it'd be worth also considering a DeGoogling category?). This is just the starting point I'm thinking of. Some patches also probably won't fall neatly in these categories either, so I can ask you if there's any I'm unsure about in regards to that.

Retold3202 commented 1 week ago

You can see what I've got done so far here, let me know what you think.

uazo commented 1 week ago

You can see what I've got done so far here, let me know what you think.

a volcano! I thank you but there is no hurry! Let me see and then I will answer you.

Retold3202 commented 1 week ago

a volcano! I thank you but there is no hurry!

Haha, yeah, I had some extra time yesterday so figured I'd start looking at the patches I was familiar with.

Let me see and then I will answer you.

👍