Skip to content

add selkies platform documentation, add mermaid dep for drawing flow charts - #43

Open
thelamer wants to merge 3 commits into
mainfrom
selkies-docs
Open

add selkies platform documentation, add mermaid dep for drawing flow charts#43
thelamer wants to merge 3 commits into
mainfrom
selkies-docs

Conversation

@thelamer

Copy link
Copy Markdown
Member

This adds docs for the full selkies platform.

Includes sections for users, developers, and explainers for all the components that make up the baseimages.

I am tired of fielding the same questions on repeat and need stuff like the quickstart and basic troubleshooting to link people to. I expanded into development docs as well to better explain how and why to make 3rd party images.

Mermaid is needed for the flow charts in some docs, I do not expect a team member to read every line of this given the size, but a glance over would be appreciated.

@thelamer
thelamer requested a review from a team August 4, 2026 13:05
@LinuxServer-CI LinuxServer-CI moved this from PRs to PRs Ready For Team Review in Issue & PR Tracker Aug 4, 2026
Comment thread docs/selkies/user-guide/apps.md Outdated
Comment on lines +56 to +70
**Browsers and web:** Brave, Chrome, Chromium, Firefox, Helium, Librewolf, Msedge, Mullvad Browser, Opera, Ungoogled Chromium, Vivaldi, Zen, Webstation

**Communication:** Altus, Ferdium, Pidgin, Signal, Telegram, Thunderbird, Webcord, Weixin

**Development:** Github Desktop, Gitqlient, Intellij Idea, Mysql Workbench, Pycharm, Sqlitebrowser, Vscode, Vscodium, Yaak

**Creative and media:** Ardour, Audacity, Blender, Darktable, Digikam, Gimp, Handbrake, Inkscape, Kdenlive, Krita, Lollypop, Rawtherapee, Shotcut, Spotube, Vlc

**Office and productivity:** Calibre, Calligra, Joplin, Libreoffice, Obsidian, Onlyoffice, Wps Office, Zotero

**3D printing and engineering:** Bambustudio, Cura, Freecad, Kicad, Orcaslicer

**Gaming and emulation:** Azahar, Blade of Agony, Dolphin, Dosbox Staging, Duckstation, Eden, Flycast, Gzdoom, Mame, Melonds, Modrinth, Pcsx2, Ppsspp, Retroarch, Rpcs3, shadPS4, Steam, Xemu, Dogwalk

**Utilities and other:** Boinc, Doublecommander, Filezilla, Keepassxc, Kali Linux, Mediaelch, Qdirstat, Remmina, Rustdesk, Wireshark, WineGUI

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This reads like a complete list, but it's static.

We can make this dynamic if desired, with downstream modifications.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Whats the plan, run a step on images that have the selkies blurb enabled to template in ? Just trying to think of solutions and the blurb is a good tag, it should be on all selkies images.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Either make the list less complete, or have the generate-images-by-category.py script generate a file we can import into this file, based on metadata. Either by a selkies category, or injecting some other value to frontmatter with jenkins.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok I simplified it to just go over categories for now. I'll ponder a better centralized list as now sealskin is manually maintained for the app list.

@LinuxServer-CI LinuxServer-CI moved this from PRs Ready For Team Review to PRs in Issue & PR Tracker Aug 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Development

Successfully merging this pull request may close these issues.

3 participants