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

Set up and populate documentation website #18

Open
sammeltassen opened this issue Oct 18, 2024 · 0 comments
Open

Set up and populate documentation website #18

sammeltassen opened this issue Oct 18, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@sammeltassen
Copy link
Collaborator

The monorepo already contains an initial documentation site in the apps/docs folder.

It would be great if this can be integrated into the current deployment and made available under heritage.tudelft.nl/docs.

I've been playing around with Observable Framework which could be nice to use for the documentation, but perhaps it's better to stick with next.js to keep it closer to the static site.

Some subjects for the documentation (to work on collaboratively):

  • Introduction to IIIF
  • Explanation of digital collection infrastructure
  • How to access the static API endpoint
  • Data model for exhibitions
  • Exhibition viewer component
  • Links to documentation of used modules used such as Canvas Panel and Vault
@sammeltassen sammeltassen added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 18, 2024
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 enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant