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

08.2023 rewrite #62

Closed
wants to merge 4 commits into from
Closed

08.2023 rewrite #62

wants to merge 4 commits into from

Conversation

meghan06
Copy link
Member

@meghan06 meghan06 commented Aug 26, 2023

Originally from #55, a series of unfortunate mistakes happened and this is a clone of the old PR.

TODO List:

From TODO.txt

  • Fix broken Jumper links in supported devices chart
  • Update macOS Post-Install to include fixing NVRAM on 10th gen devices (DevirtualizeMimo)
  • Organize guide by sections, i.e firmware pages go together in a group and whatnot
  • Make some FAQ questions (the long ones) easier to comprehend
  • Known Issues -> OS -> Linux add workaround for Broken USB-C on TigerLake and AlderLake
  • Update Terminology page to include newer CPU generations
  • Flashing Custom Firmware -> Step 2, include SuzyQ CCD as one of the possible methods
  • Flashing Custom Firmware -> Updating coreboot, make instructions more instructionaly
  • altOS -> Windows, specify that drivers are paid for SKL and newer only
  • Add SOF/AVS sleep wake crash to known issues
  • Update discounted CPUs in Windows and CSDriver page
  • Note that PopOS and Debian 12 need custom kernel
  • Post Install, add custom kernel reference (see Fix broken images introduced in the previous PR #12)

Others:

  • there is a lot of jumping around and following links, this should really be more linear
  • there is some unnecessary details in certain sections that can cause confusion, maybe these would be better if we made a section for a more detailed explanation
  • certain processes like dev mode could be explained better
  • change the order of steps and pages to be more linear (prerequisites, terminology, firmware explanation should go before any actual steps, then dev mode instructions next, then find system info, supported devices, flash fw, etc) the order will need more discussion
  • move all WP instructions to a new page, then link to that in supported devices
  • remove and reword certain sections/lines to be easier to understand all over the docs
  • explain the steps of the firmware util a little better
  • explain dev mode instructions mode, mention that you need to press ctrl + d every time you see os verification/dev mode screen
  • move updating coreboot to a new page, the current page doesn't make sense
  • give some tips for disassembling a device for people who haven't done it before
  • move the linux compatibility spreadsheet to the docs (NEEDS WORK)
  • explain keyd steps better (this really should be automated, I just need to figure out how to do that)
  • not all terminology is relevant to everyone, move the terminology relevant to each page to the top and remove the terminology page
  • create a page describing each platform/generation for OS/firmware support (linux support sheet could go here)

Other cool ideas:

  • expand the ventoy page to be for general bootable drive creation
  • explain that you should copy a code block exactly as is into the terminal (ctrl + shift + v is how you paste in a terminal)

@meghan06 meghan06 added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed labels Aug 26, 2023
@meghan06 meghan06 mentioned this pull request Aug 26, 2023
29 tasks
@ninelore ninelore closed this Sep 12, 2023
sadlerm4 added a commit to sadlerm4/docs that referenced this pull request Nov 10, 2023
…ailing spaces and unnecessary blank lines in code to address chrultrabook#87

Replace some horizontal lines with breaks for a better reading experience
Fix non-sequential numbering
Make title block on each page more uniform with consideration to adding relevant terminology for that page directly underneath the title (see open WIP checklist chrultrabook#62)

Move install directions for Chrultrabook Controller to post-install.md
Remove old information regarding running Windows on RW_LEGACY if using Ryzen
Remove accidental "reboot" instruction on purchasing-drivers.md
...and other various minor fixes
ethanaobrien pushed a commit to ethanaobrien/docz that referenced this pull request Nov 13, 2023
…ailing spaces and unnecessary blank lines in code to address chrultrabook#87

Replace some horizontal lines with breaks for a better reading experience
Fix non-sequential numbering
Make title block on each page more uniform with consideration to adding relevant terminology for that page directly underneath the title (see open WIP checklist chrultrabook#62)

Move install directions for Chrultrabook Controller to post-install.md
Remove old information regarding running Windows on RW_LEGACY if using Ryzen
Remove accidental "reboot" instruction on purchasing-drivers.md
...and other various minor fixes
ethanaobrien pushed a commit that referenced this pull request Nov 18, 2023
…ailing spaces and unnecessary blank lines in code to address #87

Replace some horizontal lines with breaks for a better reading experience
Fix non-sequential numbering
Make title block on each page more uniform with consideration to adding relevant terminology for that page directly underneath the title (see open WIP checklist #62)

Move install directions for Chrultrabook Controller to post-install.md
Remove old information regarding running Windows on RW_LEGACY if using Ryzen
Remove accidental "reboot" instruction on purchasing-drivers.md
...and other various minor fixes
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 enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants