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

Organize / update documentation (re-write) #103

Closed
wants to merge 74 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
74 commits
Select commit Hold shift + click to select a range
41a5f34
Loosely Run using vuepress
ethanaobrien Nov 11, 2023
96d4241
Fix un-closed html tags
ethanaobrien Nov 11, 2023
6bd7dbd
Change color theme to #6a4aec
ethanaobrien Nov 11, 2023
a54fe71
Migrate highlighted notes
ethanaobrien Nov 11, 2023
e0d7807
pacman prevent package reinstalls
ninelore Nov 12, 2023
7cf9608
nasm dep missing on arch
ninelore Nov 12, 2023
cfce673
arch build dep: imagemagick
ninelore Nov 12, 2023
0bc0121
Merge pull request #104 from chrultrabook/9l
meghan06 Nov 12, 2023
08031d4
Update github workflows
ethanaobrien Nov 12, 2023
8476065
Initialize node modules before building
ethanaobrien Nov 12, 2023
f24227b
Update nodejs version to 18
ethanaobrien Nov 12, 2023
3a89372
Add arch build deps (@ninelore)
ethanaobrien Nov 12, 2023
ec64ec4
Loosely Run using vuepress
ethanaobrien Nov 11, 2023
5cc8f4f
Fix un-closed html tags
ethanaobrien Nov 11, 2023
16dddac
Change color theme to #6a4aec
ethanaobrien Nov 11, 2023
73b6783
Migrate highlighted notes
ethanaobrien Nov 11, 2023
ec15c7a
Update github workflows
ethanaobrien Nov 12, 2023
b2164fe
Initialize node modules before building
ethanaobrien Nov 12, 2023
7a5d57c
Update nodejs version to 18
ethanaobrien Nov 12, 2023
d88ebab
Add arch build deps (@ninelore)
ethanaobrien Nov 12, 2023
9e3c563
Merge branch 'main' of https://github.com/ethanaobrien/docz
ethanaobrien Nov 12, 2023
a811135
Update contributing page
ethanaobrien Nov 12, 2023
6c8d06f
re-write getting-started page
ethanaobrien Nov 12, 2023
c5a36d1
Update FAQ page links
ethanaobrien Nov 12, 2023
1f4ba35
Add docs on enabling developer mode
ethanaobrien Nov 12, 2023
cbabe63
Re-write the firmware page (now flashing-firmare)
ethanaobrien Nov 12, 2023
c61b26c
Document disabling write protect with a suzyqable
ethanaobrien Nov 12, 2023
7bbecbe
Remove navigation table
ethanaobrien Nov 12, 2023
d37bd05
restore original license and readme
CoolPenguin27 Nov 12, 2023
67b77e3
merge my "split developer mode" changes
CoolPenguin27 Nov 12, 2023
faecfb9
move chrultrabook controller ad to post-install.md
CoolPenguin27 Nov 12, 2023
7070f7b
remove ("optional") and reword controlller line
CoolPenguin27 Nov 12, 2023
7547bf6
carry over "Change Ubuntu Warning for altos.md"
CoolPenguin27 Nov 12, 2023
3abdc12
upload images
CoolPenguin27 Nov 12, 2023
2c373a2
change recovery mode links to repo ones
CoolPenguin27 Nov 13, 2023
a2ffbeb
"reverting.md link to recovery mode page"
CoolPenguin27 Nov 13, 2023
a9cee11
add tablet guide to developer mode pages
CoolPenguin27 Nov 13, 2023
93157e0
Use link to self
ethanaobrien Nov 13, 2023
d429456
Merge pull request #7 from CoolPenguin27/vuepress-rebase
ethanaobrien Nov 13, 2023
a1f8c64
Edit markdown formatting and page layout for consistency, clean up tr…
sadlerm4 Nov 10, 2023
0ab99eb
Revert parts of previous commit to avoid merge conflicts with #103
sadlerm4 Nov 12, 2023
8a38d8b
Further edits to markdown formatting
sadlerm4 Nov 12, 2023
008c784
Separate Firmware related docs
ethanaobrien Nov 13, 2023
fb9929b
Separate write protect page
ethanaobrien Nov 13, 2023
b623c46
Cleanup firmware section
ethanaobrien Nov 13, 2023
506fee7
Add bigger favicon.png
ethanaobrien Nov 13, 2023
95bfcb2
Move terminology to its own section
ethanaobrien Nov 13, 2023
836c49b
Fix github ci
ethanaobrien Nov 13, 2023
159ce89
Delete pages.yml
ethanaobrien Nov 13, 2023
fba757a
Add note to use ventoy before flashing
ethanaobrien Nov 13, 2023
56fb0a3
Finalize "installing an OS" section
ethanaobrien Nov 13, 2023
56948bf
Cleanup advanced page
ethanaobrien Nov 13, 2023
9f78ac9
Document battery wp method
ethanaobrien Nov 13, 2023
e4bcf19
Various cleanup
ethanaobrien Nov 13, 2023
27c81b1
Remove dead code
ethanaobrien Nov 13, 2023
0e30caf
Fix bullet point list
ethanaobrien Nov 13, 2023
30dfc07
Fix macos bulletpoints
ethanaobrien Nov 13, 2023
027ac25
system-info.md fix developer mode link
CoolPenguin27 Nov 14, 2023
6e8fd4c
system-info.md add recovery mode board name method
CoolPenguin27 Nov 14, 2023
1a01618
flashing-firmware.md add specific guide after flashing
CoolPenguin27 Nov 14, 2023
9928c4b
flashing-firmware.md add tip to replug battery after flashing
CoolPenguin27 Nov 14, 2023
d1de5ef
supported-devices.md fix post-install links
CoolPenguin27 Nov 14, 2023
928f5f9
faq.md fix links
CoolPenguin27 Nov 14, 2023
076930f
supported-devices make links consistant
CoolPenguin27 Nov 14, 2023
10d47bb
Add custom firmware and reorganize macOS page
1Revenger1 Nov 14, 2023
0d81377
Update link to prebuilt roms
1Revenger1 Nov 14, 2023
1e9b6aa
Add hibernation page
1Revenger1 Nov 14, 2023
d7b9cce
Add hibernation modes
1Revenger1 Nov 14, 2023
7069613
Add changes to device script
ethanaobrien Nov 14, 2023
5135c46
Merge pull request #10 from CoolPenguin27/vuepress-pr
ethanaobrien Nov 14, 2023
dd40f69
Update vuepress
ethanaobrien Nov 14, 2023
e179f63
Use relative urls in html code
ethanaobrien Nov 14, 2023
9e1d1da
Merge pull request #9 from ethanaobrien/macos
ethanaobrien Nov 14, 2023
3f731e1
Change faq questions to titles
ethanaobrien Nov 14, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 5 additions & 7 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,9 @@ jobs:
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Setup Ruby
uses: ruby/setup-ruby@v1
- name: NodeJS
uses: actions/setup-node@v3
with:
ruby-version: '3.1' # Not needed with a .ruby-version file
bundler-cache: true # runs 'bundle install' and caches installed gems automatically
cache-version: 0 # Increment this number if you need to re-download cached gems
- name: Build with Jekyll
run: bundle exec jekyll build
node-version: '18'
- name: Build with node
run: npm i && npm run build
26 changes: 6 additions & 20 deletions .github/workflows/pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,53 +2,39 @@
# They are provided by a third-party and are governed by
# separate terms of service, privacy policy, and support
# documentation.

# Sample workflow for building and deploying a Jekyll site to GitHub Pages
name: Deploy Jekyll site to Pages

name: Deploy Vuepress site to Pages
on:
push:
branches: ["main"]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow one concurrent deployment
concurrency:
group: "pages"
cancel-in-progress: true

jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Setup Ruby
uses: ruby/setup-ruby@v1
- name: NodeJS
uses: actions/setup-node@v3
with:
ruby-version: '3.1' # Not needed with a .ruby-version file
bundler-cache: true # runs 'bundle install' and caches installed gems automatically
cache-version: 0 # Increment this number if you need to re-download cached gems
- name: Setup Pages
id: pages
uses: actions/configure-pages@v3
- name: Build with Jekyll
node-version: '18'
- name: Build with NodeJS
# Outputs to the './_site' directory by default
run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
env:
JEKYLL_ENV: production
run: npm i && npm run build && mv src/.vuepress/dist/ "./_site"
- name: Upload artifact
# Automatically uploads an artifact from the './_site' directory by default
uses: actions/upload-pages-artifact@v1

# Deployment job
deploy:
environment:
Expand Down
20 changes: 8 additions & 12 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,12 +1,8 @@
# Copied from https://github.com/github/gitignore/blob/main/Jekyll.gitignore
# Ignore metadata generated by Jekyll
_site/
.sass-cache/
.jekyll-cache/
.jekyll-metadata

# Ignore folders generated by Bundler
.bundle/
vendor/

Gemfile.lock
node_modules/
src/.vuepress/dist/
src/github/
yarn-error.log
node_modules
.temp
.cache
.DS_Store
9 changes: 0 additions & 9 deletions Gemfile

This file was deleted.

1 change: 0 additions & 1 deletion TODO

This file was deleted.

31 changes: 0 additions & 31 deletions _config.yml

This file was deleted.

7 changes: 0 additions & 7 deletions _includes/head_custom.html

This file was deleted.

27 changes: 0 additions & 27 deletions _includes/header_custom.html

This file was deleted.

1 change: 0 additions & 1 deletion _includes/nav_footer_custom.html

This file was deleted.

Loading