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

doc: separate page for each target #210

Closed
danth opened this issue Jan 3, 2024 · 2 comments · Fixed by #873
Closed

doc: separate page for each target #210

danth opened this issue Jan 3, 2024 · 2 comments · Fixed by #873
Labels
documentation Improvements or additions to documentation

Comments

@danth
Copy link
Owner

danth commented Jan 3, 2024

A separate page for each target would make it easier to browse through the documentation.

These pages could show more information about the target, such as:

  • A longer description
  • Which theming items it supports (wallpaper, colors, fonts, opacity, etc)
  • Which platforms it supports (Home Manager / NixOS / Darwin)
  • Options for each platform
  • Whether manual setup is required for the module to work (see the Firefox module for example)

I have a few ideas for how this documentation could be generated:

  • A hidden list which each target adds an item to:

    {
      stylix.documentationItems = [{
        targetName = "GNOME";
        targetDescription = ''
          This themes the status bar at the top of the screen, the app launcher,
           and the GDM login screen. For theming GNOME applications, see the GTK target.
        '';
        supportedItems = [ "fonts" "colors" ];
      }];
    }
    {
      stylix.documentationItems = [{
        targetName = "Firefox";
        supportedItems = [ "fonts" ];
        extraDocumentation = ''
          For this target to work, you need to fill in your profile name(s) using the option provided.
        '';
      }];
    }
  • A hidden option called targets.«name».metadata, with the same format as above

  • A separate Nix or JSON file, with the same format as above

@danth danth added the documentation Improvements or additions to documentation label Jan 3, 2024
@RANKSHANK RANKSHANK mentioned this issue Mar 2, 2024
11 tasks
@danth
Copy link
Owner Author

danth commented Mar 9, 2024

New suggestion: the extra documentation for each target could be a README.md in that folder, so it also shows up when browsing the source code

@danth danth changed the title Separate documentation page for each target doc: separate page for each target Apr 22, 2024
@danth danth linked a pull request Feb 17, 2025 that will close this issue
@trueNAHO
Copy link
Collaborator

Consider taking inspiration from the NixVim documentation.

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
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants