Patch file for documentation changes #154

Closed
opened 2026-02-06 19:21:45 +03:00 by OVERLORD · 5 comments
Owner

Originally created by @sparky8251 on GitHub (Dec 27, 2018).

Originally assigned to: @anthonylavado on GitHub.

Here is the gist: https://gist.github.com/sparky8251/47d028ee14f6a00a37ba97fb1264e714

Hopefully a diff is easy enough to merge for you guys.

This diff doesnt really add anything except a few issue tags to the issue guidelines. What it does do is standardize formatting and spacing.

Started all numbered lists with 1 instead of 0, all sub headers are 3 # instead of some being 2 or 4, used * everywhere instead of having a mix of it and -, found and fixed a few typos, etc.

I want to add to the wiki, but that's for later 🙂

Originally created by @sparky8251 on GitHub (Dec 27, 2018). Originally assigned to: @anthonylavado on GitHub. Here is the gist: https://gist.github.com/sparky8251/47d028ee14f6a00a37ba97fb1264e714 Hopefully a diff is easy enough to merge for you guys. This diff doesnt really add anything except a few issue tags to the issue guidelines. What it does do is standardize formatting and spacing. Started all numbered lists with 1 instead of 0, all sub headers are 3 # instead of some being 2 or 4, used * everywhere instead of having a mix of it and -, found and fixed a few typos, etc. I want to add to the wiki, but that's for later :slightly_smiling_face:
Author
Owner

@JustAMan commented on GitHub (Dec 28, 2018):

@sparky8251 can you add patched versions of files to the gist? It makes understanding final formatting easier.

@JustAMan commented on GitHub (Dec 28, 2018): @sparky8251 can you add patched versions of files to the gist? It makes understanding final formatting easier.
Author
Owner

@sparky8251 commented on GitHub (Dec 28, 2018):

Done and done. Check the gist link again and it should have all the files as they would appear after patching.

@sparky8251 commented on GitHub (Dec 28, 2018): Done and done. Check the gist link again and it should have all the files as they would appear after patching.
Author
Owner

@joshuaboniface commented on GitHub (Dec 30, 2018):

Integrated into the Wiki at https://github.com/jellyfin/jellyfin/wiki/Building-from-Source

@joshuaboniface commented on GitHub (Dec 30, 2018): Integrated into the Wiki at https://github.com/jellyfin/jellyfin/wiki/Building-from-Source
Author
Owner

@joshuaboniface commented on GitHub (Dec 30, 2018):

A lot of these changes reference lists and such, a few I agree with but I like the 0. style since that auto-increments and avoids messing with numbering. That it starts at 0 instead of 1 is not particularly important IMO.

However there are a lot of good suggestions here and I'll keep working through them.

@joshuaboniface commented on GitHub (Dec 30, 2018): A lot of these changes reference lists and such, a few I agree with but I like the `0.` style since that auto-increments and avoids messing with numbering. That it starts at 0 instead of 1 is not particularly important IMO. However there are a lot of good suggestions here and I'll keep working through them.
Author
Owner

@sparky8251 commented on GitHub (Dec 30, 2018):

Using 1 for everything also auto increments on the Github wiki. Just figured that 1 is more commonly used by non-programmers, the ones that are likely to be contributing documentation edits as one offs and that we should be accessible to.

Especially since the documentation should be standardized with a "wiki style" like the coding style. This was just my attempt at implementing such a thing.

@sparky8251 commented on GitHub (Dec 30, 2018): Using 1 for everything also auto increments on the Github wiki. Just figured that 1 is more commonly used by non-programmers, the ones that are likely to be contributing documentation edits as one offs and that we should be accessible to. Especially since the documentation should be standardized with a "wiki style" like the coding style. This was just my attempt at implementing such a thing.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/jellyfin#154