Skip to content

Styleguide (KSS) usage & deployment #6696

Open
@janbrasna

Description

@janbrasna

Wondering how the styleguide content and its entrypoints fit within the project, how are supposed to be used, and if/where are generally available, the impression I got was they are being somewhat forgotten over time, which is a shame given the effort put into it — nonetheless I wasn't able to find any mention in the docs or any workflows so it very well could just have been some tribal knowledge only…

Surprisingly I wasn't even able to get kss to build locally with current configs, so wasn't sure how — if ever — it is getting used, or supposed to be consumed or updated. After a couple of tweaks to get it to build it looked like that's something worth having as a reference online, in the published docs, for anyone to be able to look into things without having to either envision it just from sources, or having to build own copies of the styleguide.

Would it make sense to have it as part of the kitsune docs deployment?

I made a quick PoC: https://janbrasna.github.io/kitsune/_kss/ just getting the content updated with CI.

(I chose the _kss subdir to make sure it won't interfere with built mkdocs outputs in the same workdir… does that make sense or it should be renamed/moved elsewhere?)

If that looks like something worth adding, I'll also add a link to it to the main docs, and open a PR with it.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status

    ❓ triage

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions