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

Improve module readmes #207

Open
allanaaa opened this issue Sep 4, 2024 · 0 comments
Open

Improve module readmes #207

allanaaa opened this issue Sep 4, 2024 · 0 comments

Comments

@allanaaa
Copy link
Contributor

allanaaa commented Sep 4, 2024

This is not an issue on this repository, just a to-do item for me. The module readmes are displayed on the website's module directory, but some have very little information about why a user would want to install it. Readmes also contain lots of developer info that can show up quite high on the page and perhaps put off prospective users.

So:
For each module, add more general info about module function and features (and requirements) to each readme. This includes a fix for PR #145, which is developer info that should be in the readme.

Note to self that Readme links need to be markdown-formatted. They appear clickable in the readmes on github but do not render as links on our website.

allanaaa added a commit to omeka-s-modules/CustomVocab that referenced this issue Sep 4, 2024
allanaaa added a commit to omeka-s-modules/Collecting that referenced this issue Sep 4, 2024
allanaaa added a commit to allanaaa/CopyResources that referenced this issue Sep 4, 2024
allanaaa added a commit to omeka-s-modules/CSSEditor that referenced this issue Sep 4, 2024
allanaaa added a commit to omeka-s-modules/CSVImport that referenced this issue Sep 4, 2024
allanaaa added a commit to omeka-s-modules/CSVImport that referenced this issue Sep 4, 2024
allanaaa added a commit to omeka-s-modules/DspaceConnector that referenced this issue Sep 11, 2024
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