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

Improving the documentation #1273

Open
uazo opened this issue Jul 7, 2024 · 4 comments
Open

Improving the documentation #1273

uazo opened this issue Jul 7, 2024 · 4 comments
Labels
documentation Improvements or additions to documentation

Comments

@uazo
Copy link
Owner

uazo commented Jul 7, 2024

follow up from #1237 (comment)

@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

@uazo uazo added the documentation Improvements or additions to documentation label Jul 7, 2024
@celenityy
Copy link

celenityy commented Jul 7, 2024

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.

@celenityy
Copy link

celenityy commented Jul 7, 2024

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

@uazo
Copy link
Owner Author

uazo commented Jul 8, 2024

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.

@celenityy
Copy link

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.

👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants