Skip to content

Commit

Permalink
docs: fix links
Browse files Browse the repository at this point in the history
  • Loading branch information
geritwagner committed Apr 29, 2024
1 parent abdfd3a commit 355f5e1
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/source/dev_docs/packages.rst
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ Documentation
-----------------

* Link the documentation (`README.md`) in the pyproject.toml.
* To integrate the package documentation into the official CoLRev documentation, run the ``colrev env --update_package_list`` command. This updates the `package_endpoints.json <https://github.com/CoLRev-Environment/colrev/blob/main/docs/source/package_endpoints.json>`_, and the `search_source_types.json.json <https://github.com/CoLRev-Environment/colrev/blob/main/colrev/docs/source/search_source_types.json.json>`_, which are used to generate the documentation pages.
* To integrate the package documentation into the official CoLRev documentation, run the ``colrev env --update_package_list`` command. This updates the `package_endpoints.json <https://github.com/CoLRev-Environment/colrev/blob/main/docs/source/package_endpoints.json>`_, and the `search_source_types.json <https://github.com/CoLRev-Environment/colrev/blob/main/colrev/docs/source/search_source_types.json>`_, which are used to generate the documentation pages.
* See `tests/REAMDE.md <https://github.com/CoLRev-Environment/colrev/tree/main/docs>` for details on building the CoLRev docs.

Testing
Expand Down
2 changes: 1 addition & 1 deletion docs/source/manual/pdf_screen.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ CoLRev supports the reconciliation with the ``colrev merge`` operation.

Although most methodological sources suggest to complete the screen before the data analysis and synthesis step, others propose an integrated cycle of materials screening, assessment, mapping, and synthesis.
In CoLRev, this can be accomplished by means of a retrospective screen, in which all records are included initially (using ``colrev screen --include_all_always``), but potentialy excluded during the cycle iterations.
For example, this can be done using the `EXCLUDE annotation <https://github.com/CoLRev-Environment/colrev/blob/main/colrev/packages/data/paper_md.md>`_ in a paper.
For example, this can be done using the `EXCLUDE annotation <https://github.com/CoLRev-Environment/colrev/blob/main/colrev/packages/paper_md/README.md>`_ in a paper.

..
TODO : add colrev screen --exclude IDs
Expand Down

0 comments on commit 355f5e1

Please sign in to comment.