Would like to contribute to docs

[tomootes]

Hi @bfabio!

Here i am once again 🙋

At developer.overheid.nl, we would like to link to the pc.yml tools/ resources. To be more precise, this example page:
https://yml.publiccode.tools/example.html

I think we could improve two things to make the page more usable,

• The quality of the example
• We could add a copy button

Further improvements to the example page could be:

• A selector for languages so we can add an "nl"-properties if this language is checked. This could provide country-specific hints.

Also i would like to fix these things to the docs in general:

• Fix the link at the page saying "© Copyright . ". I think it should link to the AUTHORS.md.
• Add a Github icon to the header so its easier to find out how to contribute

**Wrong repo? 🤔 **
I found this repo: https://github.com/publiccodeyml/publiccode.tools and assumed it represents the docs over here: https://yml.publiccode.tools/. I also ran it locally but it seems that its just a simple example blog? I suppose its not the theme that represents https://yml.publiccode.tools/ since i don't see any content there as well?

If it is true publiccodeyml/publiccode.tools is deprecated, maybe remove it?

Where do I start if I would like to improve https://yml.publiccode.tools/? The theme in https://github.com/publiccodeyml/publiccode.yml doesn't seem documented?

Thanks a lot in advance!

[ruphy]

hello hello @tomootes, welcome! the code that you're looking for is in this repo

[bfabio]

Hey @tomootes, nice to hear from you!

Take a look here: https://github.com/publiccodeyml/publiccode.yml/tree/main/docs/standard. This is the source where the spec is deployed. It’s a Read the Docs site, so be aware there are certain limitations.

https://github.com/publiccodeyml/publiccode.tools is just the skeleton of a future (hint! help needed) landing page for the publiccode.yml project. Think of it as a less technical page that describes the project and its goals while linking all resources together. Ideally, it would be hosted at https://publiccode.tools/. So, it's not deprecated—it’s just waiting for some design and love.

[tomootes]

@ruphy @bfabio thanks for the info.

I created a PR addressing the problem i stated earlier. Namely that it's tough to find the github repo once you've arrived at https://yml.publiccode.tools/.

Now that i have some experience with Sphinx and the used theme, i can imagine it might be tough to add a copy button next to the example-template. Maybe ill try this later.

Awesome to hear there is still the plan to make a product-website/ landing-page! For me, contributing to this website is easily doable because have quite some experience using Jekyll. As you state, i think it might be good to start out by creating a (ux)design for this first. And a session on what we would like to tell?