research-software-directory / documentation

This repository contains the user documentation for the Research Software Directory
0 stars 3 forks source link

User documentation update to v2 #8

Closed dmijatovic closed 11 months ago

dmijatovic commented 11 months ago

Minimal documentation update

Based on the list from the issue #985. The points marked [x] are included in this PR.

[x] Software overview [x] Project overview [x] Organisation overview

Optional

These pages/sections can be improved or added to documentation

[x] Home page image can be updated [x] favicon is not show in the tab [x] Sign in image can be updated. [x] Organisation card image needs update

Software

[ ] Edit software information video missing upload logo feature [ ] Software mentions does not have bulk import feature [ ] Maintainers section is missing [ ] Package managers section is not in documenation [ ] Related topics (software and projects) is not in documentation. Use same section from project documenation?

Projects

[ ] Maintainers section is missing

Organsations

[ ] Organisation section is missing

FAQ

[ ] The section is empty. Maybe use some questions/answers we answered in the past?

How to test?

To view changes locally you can inspect markdown files. To view it in the browser follow these steps (you need node and yarn installed).

# install dependencies
yarn install 
# start dev server on http://localhost:3030
yarn dev