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

Rework docs #46

Open
camh- opened this issue Aug 24, 2022 · 1 comment
Open

Rework docs #46

camh- opened this issue Aug 24, 2022 · 1 comment

Comments

@camh-
Copy link
Member

camh- commented Aug 24, 2022

The README is a bit too detailed for a README. Move most of the content to docs/jsonnet.md and add content for metadata, which is currently implemented but undocumented. Perhaps some of the docs belong in a more generic eval.md document, since there is stuff common to all evaluators (the interface).

The README should focus on getting started and showing simple uses.

@juliaogris
Copy link
Member

Not necessarily related to this issue - but maybe worth considering while reworking docs:

Just like we increasingly seem to be refining the Makefile (template) it might be worth while to get some docs template up as well.

In particular:

  • README badges
  • hermit snippet (what it is, activation, link)
  • make help
  • contribution section ?

WRT to docs in the docs folder - maybe, very maybe, we should consider to also create GitHub pages for them by default at https://jig.foxygoat.dev or https://jig.docs.foxygo.at ... I'm only suggesting this because sometimes pure markdown falls short, especially wrt syntax colouring of lesser known languages (WSN was one I was looking for). However, it seem jsonnet is supported.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants