[DOCS] Documentation Overhaul (docs v2) #163
Description
Welcome to Kelly County: Docs v2.0!
This issue has been made as the documentation has recently become, well, a mess. With this overhaul, I am aiming for the documentation to become easier to follow, read, and understand. As well as having more useful topics covered.
Another thing about the current documentation that requires changing is the length of some pages. Why? Because having to scroll through a page to find 1 specific bit of information is just... not fun. It's simply tedious at times. So here it goes, I am going to re-do - absolutely every bit of the docs from scratch. From just the introduction channel, and even that is going to change.
Overhaul (Part 1): Navigation Bar
So, the navigation bar. I would question the way it's laid out - but I've realized that questioning things is useless and it should just be fixed. Here's a reference image for what it looked like before this overhaul has started:
The Goal:
- Include more useful categories on the left side. Keep the categories logical and make them make sense.
Overhaul (Part 2): Sidebar & General Navigation
Okay, this just hurts to look at. But here goes the original:
The Goal:
- Re-organize the sidebar. Make it clean, efficient, and don't expand categories that don't need to be expanded by default. This is just ugly. Also, fix the inconsistencies with SPAG and formatting.
- Include more pages and improve the "Table of Contents" to include most (if not all) of the links as well.
Overhaul (Part 3): The Blog
I was very wrong when I said that blogs are lame. We need a space for development updates and keeping our community up-to-date. So, let's do just that. No "before photo" as well; it doesn't currently exist. The task is simple, make a blog.
The Goal:
- Enable and start working on the initial KC v2.0 Blog Post within the documentation
- Put a link to the blog in the navbar
- Put a link to the blog in both the ToC & Sidebar
- Configure blog authors:
Paneedah,Skyy,Ace,MindVoid
Overhaul (Part 4): The Final Part!
The final, yet also the most tedious. Re-write every single section using at least semi-decent MD and make sure it's readable. Don't miss any important information, and make sure it's easy to read. Probably the main part of this re-write, yet I still left it to be last. Why? Because this is an absolutely crazy amount of fucking work.
- Introduction / Table of Contents
- What's New? (redirect link to new blog)
- Getting Started
- Joining KCDOJRP
- In-Game Commands
- Server Rules
- Microphone Setup
- Trusted Civilians
- Priority Status
- 32-Sirens
- Your Characters
- Creating
- Clothing Reel
- Ammunation
- Your Vehicles
- Creating
- Vehicle Display
- Engine Fuel
- Mechanic
- Tow Vehicle Attach
- Helicopter HUD
- Postals
- Postals
-
/postalcommand - Blips
- Area of Play
- Things To Do
- Robberies
- Camera
- KC-Menu
- About
- How to Use
- The CAD
- About
- Manage Business
- Join & Apply for Business
- Fire, EMS & LEO Usage
- Dispatch Usage
- Law Enforcement
- Apply
- Roster
- Learning
- Structure
- Alphabet
- 10-Codes
- D-Codes
- SOP
- Setting Up
- First Shift
- FTO Guide
- Tools
- Radar
- LVC Sirens
- Radio
- LEO Actions
- Fire & EMS
- Apply
- Roster
- Learning
- Structure
- Responsibilities
- SOP
- Setting Up
- First Shift
- FTO Guide
- Tools
- Fire & EMS Actions
- AntiCheat
- About
-
Messages - Punishment Tracker
- Reporting
- Appeals
What does this achieve?
Implementing will allow players to have easier and simpler access to any and all information that they may need and should save us time in the long-run from having to repeat instructions to people - we can just link a good documentation instead.
We also get a lot of new players, so I feel like this would be beneficial all-round.