Project60 / org.project60.banking

CiviCRM banking extension
18 stars 38 forks source link

Documentation updates #402

Closed RositzaDikova closed 7 months ago

RositzaDikova commented 1 year ago

Fix #401 Updated the documentation sections for import, analysers and matchers, provided more information for implementers based on compact examples.

MarcMichalsky commented 1 year ago

I would like to make a few changes to the content and visuals. I will submit a PR on your fork.

RositzaDikova commented 1 year ago

@MarcMichalsky Thank you for this! I have converted the PR to draft for now - I hope this is OK.

MarcMichalsky commented 9 months ago

I created a PR on your branch, @RositzaDikova!

RositzaDikova commented 9 months ago

This is a follow up on the documentation updates/improvements, started off during the CiviSprint in Leipzig 2023 and now ready for review.

@jensschuppe Dear Jens, you seem to be the person most recently involved in documentation updates issues and PRs, so I kindly ask for your attention on the pull request.

Big thanks goes to @MarcMichalsky who has improved greatly the analyzer and matchers section, and of course to all involved in the updates during the sprint!

jensschuppe commented 8 months ago

I'm afraid I won't get to thoroughly reviewing this anytime soon, so I'd suggest we just merge it (as it's docs only) and rely on your extensive work (Thanks!), and, more importantly, people testing their configuration, even when strictly following the docs.

I guess you "prosaized" the actual code for the individual plugins, so this should be accurate.

One thing, mkdocs serve has this warning:

INFO    -  The following pages exist in the docs directory, but are not included in the "nav" configuration:
             - reference.md
             - configuration/plugins/importer-actions.md

@RositzaDikova or @MarcMichalsky could you address this?

@bjendres anything more to add before merging?

RositzaDikova commented 7 months ago

@jensschuppe Sorry for not replying earlier on this!

jensschuppe commented 7 months ago

I personally really like the concept of having every page in the navigation tree somewhere for quick access and for seeing where in the tree I am when viewing the page, so I'd vote for adding it somewhere. Also, I think the docs publisher on civicrm.org will complain about such issues, but I'm not sure …

Anyway, the link to importer-actions.md is a link to the file on GitHub, I guess that should be a relative link so that the file will be opened within the MKDocs book.

jensschuppe commented 7 months ago

Thanks a lot @RositzaDikova and @MarcMichalsky for your efforts in improving the CiviBanking docs!

In all its glory: https://docs.civicrm.org/banking