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

Resource Landing Page: Display resource owner-defined access and usage examples that may contain code #163

Open
horsburgh opened this issue May 28, 2024 · 0 comments

Comments

@horsburgh
Copy link
Contributor

From the functional specifications:

Display resource owner-defined access and usage examples that may contain code. Examples will be provided for the user to choose from for common content types (e.g., launching notebooks)

  • Code can be copied and pasted into a terminal/notebook/etc., and formatting is preserved
  • Syntax highlighting
  • Code language is displayed
  • Contains a description and potentially instructions
  • Graphical representation of “haspart” and “ispartof” relationships that allows users to navigate parent/child relationships.

One simple way to do this may be to encourage use of a readme.md file that is part of the resource content.

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

1 participant