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

Create documentation landing page #22

Closed
sdruskat opened this issue Aug 4, 2021 · 2 comments · Fixed by #34
Closed

Create documentation landing page #22

sdruskat opened this issue Aug 4, 2021 · 2 comments · Fixed by #34
Assignees

Comments

@sdruskat
Copy link
Member

sdruskat commented Aug 4, 2021

  • Currently, the "Documentation" link links to the README.
  • To accommodate tutorials, create a landing page that will
    • link to the docs (README, guide) at the top
    • Includes tutorials on validation w/ validator.py, cffconvert (when supported), ruby-cff, ideally link to a validator that's easier to use, e.g., a Jupyter Notebook hosted somewhere (GitHub Codespaces, binderhub, etc.), or a simple web app based on jsonschema or similar (see if we can reuse any of the existing linters!)
@sdruskat sdruskat mentioned this issue Aug 4, 2021
3 tasks
@sdruskat sdruskat added this to the Site update for 1.2.0 milestone Aug 4, 2021
@sdruskat
Copy link
Member Author

Not sure about this anymore, perhaps we should just add a new nav link to a dedicated Tutorials page.

@sdruskat sdruskat mentioned this issue Aug 11, 2021
1 task
@sdruskat
Copy link
Member Author

Not sure about this anymore, perhaps we should just add a new nav link to a dedicated Tutorials page.

Done in #34.

@sdruskat sdruskat self-assigned this Aug 11, 2021
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

Successfully merging a pull request may close this issue.

1 participant