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

Huge rework with a new documentation page for the new install process #4

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

alexAubin
Copy link
Member

Soooo this is a rework of this entire repo following the rework of the install process...

I started by pretty much nuking the entire repo ... not sure if that's the right thing to do ...

  • the entire 'hypercube generation interface' is removed because not relevant anymore
    • related files: index.html, img/, i18n/, css, js, libs, css, font
  • I don't know what to do with the "caption" folder or why it's here in the first place ... from what I understand it's related to the video on the landpage, but I believe it's another repo ..?
  • There's a folder with the stickers ... I don't know if that's the right place to store this ... Same thing for the documentation for dotcube files... More generally I'm always confused about how files a spread in so many repos ... (landpage + install.labrique + repo.labrique) ... imho we should have a single repo for the entire website/doc (and only for website/doc-related stuff..)

The new files are :

  • a new index.html which contains the important content
  • a bunch of web static files (js, css, font, img) in static/, various libs like bootstrap / jquery / fontawesome / ...

Here's a screenshot of the first draft :

new_cube_install_doc

Some todolist items and possible iterations :

  • review and try to make the content as moldu-friendly as possible
  • add a strong advise for non-technical people to do this with a technical people (possibly from the ISP) that can explain the
    various notions + help troubleshoot
  • i18n
  • having to fetch the image from repo.internet.cube is cryptic ... we should design something to be able to download the image right from the page
  • having to use Etcher is a bit meh ... I discovered recently rpi-imager used by the Raspberry Pi project which is super lightweight and cross-platform. Only drawback is that their branding is going to confuse people as hell ("my board is not a RPi but I'm flashing it with a RPi tool !?"). Maybe someday™ we could try to customize/remove the branding...
  • Keoma started working on a video tutorial at some point, which could be better than a wall of instructions (though already simpler than the current process)

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

Successfully merging this pull request may close these issues.

1 participant