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

Update docs frontpage to show mapping metadata and examples at a glance #393

Merged
merged 7 commits into from
Nov 4, 2024

Conversation

matentzn
Copy link
Collaborator

@matentzn matentzn commented Nov 2, 2024

Resolves #392

This PR updates the front page to show at a glance the mapping level metadata fields, and a better view of a SSSOM example table.

  • docs/ have been added/updated if necessary
  • make test has been run locally
  • tests have been added/updated (if applicable)
  • CHANGELOG.md has been updated.

@matentzn matentzn requested a review from cthoyt November 2, 2024 23:59
@cthoyt
Copy link
Member

cthoyt commented Nov 3, 2024

I want to review this but the make gendoc command gives the following error:

$ make gendoc
cp -rf src/docs/* docs ; \
	poetry run gen-doc -d docs src/sssom_schema/schema/sssom_schema.yaml --template-directory src/doc-templates --index-name linkml-index
Command not found: gen-doc
make: *** [gendoc] Error 1

I tried a couple other things but I am not very good with makefiles and it's not really clear what to do in what order. make install also had issues, I'm assuming due to issues with poetry (it's time to switch to uv ;))

@matentzn
Copy link
Collaborator Author

matentzn commented Nov 3, 2024

Poetry install?

@matentzn
Copy link
Collaborator Author

matentzn commented Nov 4, 2024

Here is the generated markdown:

https://www.dropbox.com/scl/fi/bqf5puioqogqvipzs2ev3/sssom_index_updated.md?rlkey=h59uwwkuursys8wf4hcvndort&dl=0

Anything else you want to see?

@cthoyt
Copy link
Member

cthoyt commented Nov 4, 2024

This gets the job done nicely, thanks

@matentzn matentzn requested a review from jamesamcl November 4, 2024 16:00
@jamesamcl
Copy link
Member

The content LGTM, I don't know enough about the jinjinate stuff to comment but I'm sure it's fine

@matentzn matentzn merged commit d8a2c93 into master Nov 4, 2024
3 checks passed
@matentzn matentzn deleted the issue392-docs-frontpage branch November 4, 2024 18:08
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 this pull request may close these issues.

Front page of SSSOM website desperately needs to list what the columns in an SSSOM file are/can be
3 participants