inveniosoftware / inveniosoftware/cookiecutter-invenio-instance

global: full documentation validation

Open
#218 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
6
Forks
38
PR merge metrics
No merged PRs in 30d

Description

The objective of this issue is to validate the entire v3.2 release from an end-user perspective.

Validate here means:
- Verify that all instructions works and output is consistent with what is displayed
- Verify that it makes sense from an overall perspective.

- Validate "Get started" on [inveniosoftware.org](https://inveniosoftware.org/products/framework/)
- Validate [Invenio Framework documentation](https://invenio.readthedocs.io/en/latest/):
- Read and validate each chapter of the documentation. Does it work? Does it make sense? Is it consistent with the rest of the documentation?

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the “Get started” content on inveniosoftware.org, then read each chapter of the Invenio Framework documentation at invenio.readthedocs.io/en/latest/. Check that every instruction works, outputs match what is shown, and the documentation is coherent and consistent overall. Done means recording and addressing all validation findings across the v3.2 documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.