Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
  • D Developer Tutorial and Article Site
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 52
    • Issues 52
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 14
    • Merge requests 14
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Releases
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • DocumentationDocumentation
  • Developer Tutorial and Article Site
  • Issues
  • #64
Closed
Open
Issue created Nov 22, 2021 by Mikhail Zolotukhin@gikariDeveloper

Improve the structure of the documentation

The Problem

Currently, the sidebar looks like this:

Screenshot_20211122_193305

It is just a bunch of random tutorials, that somehow relate to KDE. This makes finding the relevant information for the developer hard.

Possible Solution

I propose splitting all the tutorials to the three categories (wording and order may be different):

  1. Relying on KDE Technologies
  2. Extending KDE Technologies
  3. Building KDE Technologies

"Relying on" would contain all the things the developer would like to know, when developing a cross-platform or Linux app using KDE Tech:

  • Kirigami
  • Getting Started (btw, very weird section, it's about building a desktop app using KDE Frameworks, right?)
  • Configuration (KConfig and KConfigXT)
  • IPC via DBus
  • Session Management
  • KArchive
  • Desktop file
  • KAuth
  • KIdle (detecting system idle state)
  • Akonaldi
  • Concurrency
  • Spell checking

"Extending" section would contain all the things the developer would like to know, when developing an extension for the official KDE Software:

  • Sensors for System Monitor
  • Dolphin Plugins
  • KCM subsection from the present configuration section
  • Plasma plugins (KWin Scripts, Applets etc.)

"Building" section would contain all the things the developer would like to know, when developing official KDE Software:

  • Icons
  • Plasma Mobile
  • Flatpak distribution

Some things would eventually overlap, but I think in these cases separate tutorials with deduplication via the cross-linking would be a good solution. The idea is that the developer for each section may know the stuff from another section: "Relying on" dev shouldn't know anything prior, "Extending" dev may know something about "relying on" to be able to extend, "Build" dev may know about extending and relying on to be able to build.

Edited Nov 23, 2021 by Mikhail Zolotukhin
Assignee
Assign to
Time tracking