Update readme and contributing #590

f-brinkmann · 2024-04-19T08:08:26Z

Which issue(s) are closed by this pull request?

Part of pyfar/gallery#20.
Changes in the readme might conflict with #574. I think the readme here might be the final version.

Changes proposed in this pull request:

Adapt README and CONTRIBUTING to new pyfar-wide help section
Flatten toc for Getting started and Contributing section in the docs to get a cleaner start page.
Check link to help section in README and the link to the community in Contributing after merging ttps://github.com/Harmonize documentation between pyfar packages gallery#20

update readme and contributing

ahms5

Thank you, just a few comments!

README.rst

ahms5 · 2024-04-22T07:18:55Z

README.rst

-.. _contribution guidelines: https://github.com/pyfar/pyfar/blob/develop/CONTRIBUTING.rst
+.. _pyfar workshop: https://mybinder.org/v2/gh/pyfar/gallery/main?labpath=docs/gallery/interactive/pyfar_introduction.ipynb
+.. _pyfar example gallery: https://pyfar-gallery.readthedocs.io/en/latest/examples_gallery.html
+.. _pyfar documentation: https://pyfar.readthedocs.io/en/stable


Suggested change

.. _pyfar documentation: https://pyfar.readthedocs.io/en/stable

.. _pyfar documentation: https://pyfar.readthedocs.io

ahms5 · 2024-04-22T07:19:18Z

README.rst

 .. _pyfar.org: https://pyfar.org
-.. _read the docs: https://pyfar.readthedocs.io/en/latest
-.. _SoundFile: https://pysoundfile.readthedocs.io/en/latest/
+.. _SoundFile: https://pysoundfile.readthedocs.io/en/stable


Suggested change

.. _SoundFile: https://pysoundfile.readthedocs.io/en/stable

.. _SoundFile: https://pysoundfile.readthedocs.io

ahms5 · 2024-04-22T07:21:11Z

CONTRIBUTING.rst

+Guide lines
+-----------

-Before you submit a pull request, check that it meets these guidelines:
+You can find our general guidelines in the `pyfar community`_.


maybe we can add a general intro at the beginning of this doc. something that explains the general and specific guidelines. Maybe this part can be moved to the beginning so it is clear from the start.

ahms5

Thanks! small comments, then I will approve.

ahms5 · 2024-04-22T12:59:17Z

CONTRIBUTING.rst

-helps, and credit will always be given.
+helps, and credit will always be given. The following helps you to start
+contributing to pyfar. General guidelines for example regarding the style
+of code and documentation are part of the You can find our general


Suggested change

of code and documentation are part of the You can find our general

of code and documentation are part of our general

ahms5 · 2024-04-22T13:00:58Z

CONTRIBUTING.rst

- check gallery in `binder`_
-
-.. _binder: https://mybinder.org/v2/gh/pyfar/gallery/main?filepath=docs/gallery
+.. _pyfar community: https://pyfar-gallery.readthedocs.io/en/latest/community.html


Suggested change

.. _pyfar community: https://pyfar-gallery.readthedocs.io/en/latest/community.html

.. _pyfar community: https://pyfar-gallery.readthedocs.io/en/latest/community

the old link wont work.

ahms5 · 2024-04-22T13:03:26Z

README.rst

 .. _libsndfile: http://www.mega-nerd.com/libsndfile/
+.. _help section: https://pyfar-gallery.readthedocs.io/en/latest/help.html


Suggested change

.. _help section: https://pyfar-gallery.readthedocs.io/en/latest/help.html

.. _help section: https://pyfar-gallery.readthedocs.io/en/latest/help

mberz · 2024-05-03T10:49:41Z

README.rst

-
-.. _contribution guidelines: https://github.com/pyfar/pyfar/blob/develop/CONTRIBUTING.rst
+.. _pyfar workshop: https://mybinder.org/v2/gh/pyfar/gallery/main?labpath=docs/gallery/interactive/pyfar_introduction.ipynb
+.. _pyfar example gallery: https://pyfar-gallery.readthedocs.io/en/latest/examples_gallery.html


Suggested change

.. _pyfar example gallery: https://pyfar-gallery.readthedocs.io/en/latest/examples_gallery.html

.. _pyfar example gallery: https://pyfar.org

mberz · 2024-05-03T10:52:33Z

README.rst

+The `pyfar workshop`_ gives an overview of the most important pyfar
+functionality and is a good starting point. It is part of the
+`pyfar example gallery`_ that also contains more specific and in-depth
+examples. The  `pyfar documentation`_ gives a detailed and complete
+overview of pyfar. All these information are available from `pyfar.org`_.


Suggested change

The `pyfar workshop`_ gives an overview of the most important pyfar

functionality and is a good starting point. It is part of the

`pyfar example gallery`_ that also contains more specific and in-depth

examples. The `pyfar documentation`_ gives a detailed and complete

overview of pyfar. All these information are available from `pyfar.org`_.

For a list of application examples including introductions to most important functionality check out the `pyfar example gallery`_ and `pyfar workshop`_ . All gallery example notebooks can be executed interactively without a local installation by clicking the mybinder.org button on the respective example.

A full overview of all features is found in the `pyfar documentation`_ .

I actually prefer the current version. It first links the workshop, which might be the easiest entry to the entrire package and explicitly links the gallery, not only pyfar.org. Would you be fine with leaving it as it is?

Update README.rst

749cbc9

update readme and contributing

f-brinkmann added the documentation Everything related to docstrings and comments label Apr 19, 2024

github-actions bot added this to In progress in Code Backlog Apr 19, 2024

This was referenced Apr 19, 2024

Harmonize documentation between pyfar packages pyfar/gallery#20

Open

Remove examples #574

Merged

f-brinkmann requested review from ahms5, pingelit and mberz April 19, 2024 08:15

ahms5 added the 0.6.6 label Apr 19, 2024

Merge branch 'main' into update/readme

127945c

f-brinkmann requested review from tluebeck and sikersten April 20, 2024 11:45

ahms5 requested changes Apr 22, 2024

View reviewed changes

Code Backlog automation moved this from In progress to Review in progress Apr 22, 2024

review according to ahms-5

5ebaeca

f-brinkmann requested a review from ahms5 April 22, 2024 11:29

ahms5 requested changes Apr 22, 2024

View reviewed changes

comments from ahms-5

61fe783

f-brinkmann requested a review from ahms5 April 22, 2024 13:14

ahms5 approved these changes Apr 22, 2024

View reviewed changes

Code Backlog automation moved this from Review in progress to Reviewer approved Apr 22, 2024

ahms5 added the cookiecutter Need to be updates in cookiecutter label Apr 25, 2024

ahms5 temporarily deployed to test April 25, 2024 10:02 — with GitHub Actions Inactive

ahms5 mentioned this pull request Apr 25, 2024

Update readme and contributing pyfar/cookiecutter-pypackage#20

Open

mberz requested changes May 3, 2024

View reviewed changes

Code Backlog automation moved this from Reviewer approved to Review in progress May 3, 2024

f-brinkmann added 2 commits May 3, 2024 14:36

Merge branch 'main' into update/readme

a98e8d8

Update index.rst

45d60b3

f-brinkmann force-pushed the update/readme branch from f05d733 to 45d60b3 Compare May 3, 2024 12:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update readme and contributing #590

Update readme and contributing #590

f-brinkmann commented Apr 19, 2024 •

edited

ahms5 left a comment

ahms5 Apr 22, 2024

f-brinkmann Apr 22, 2024

ahms5 Apr 22, 2024

f-brinkmann Apr 22, 2024

ahms5 Apr 22, 2024

ahms5 left a comment

ahms5 Apr 22, 2024

ahms5 Apr 22, 2024

ahms5 Apr 22, 2024

mberz May 3, 2024

mberz May 3, 2024

f-brinkmann May 3, 2024

	.. _pyfar documentation: https://pyfar.readthedocs.io/en/stable
	.. _pyfar documentation: https://pyfar.readthedocs.io

	.. _SoundFile: https://pysoundfile.readthedocs.io/en/stable
	.. _SoundFile: https://pysoundfile.readthedocs.io

	of code and documentation are part of the You can find our general
	of code and documentation are part of our general

	.. _pyfar community: https://pyfar-gallery.readthedocs.io/en/latest/community.html
	.. _pyfar community: https://pyfar-gallery.readthedocs.io/en/latest/community

		.. _libsndfile: http://www.mega-nerd.com/libsndfile/
		.. _help section: https://pyfar-gallery.readthedocs.io/en/latest/help.html

	.. _pyfar example gallery: https://pyfar-gallery.readthedocs.io/en/latest/examples_gallery.html
	.. _pyfar example gallery: https://pyfar.org

Update readme and contributing #590

Are you sure you want to change the base?

Update readme and contributing #590

Conversation

f-brinkmann commented Apr 19, 2024 • edited

Which issue(s) are closed by this pull request?

Changes proposed in this pull request:

ahms5 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ahms5 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

f-brinkmann commented Apr 19, 2024 •

edited