Skip to content

docs folder: Create readme.md #1172

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mjavurek wants to merge 1 commit into
base: feature/1058-extended-article-units
Choose a base branch
from
Open

docs folder: Create readme.md #1172

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions doc/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Foodsoft Development Documentation

Here are some documentations helpful for the foodsoft development.

A user documentation can be found at https://docs.foodcoops.net/
Copy link
Copy Markdown
Contributor

@lentschi lentschi May 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm... considering the readme is written in English, I guess this should link to https://docs.foodcoops.net/en/home instead, but then again there's nothing there 🤔
So, to be honest, I'm not sure if this PR makes sense at this moment. Probably we should first decide which way we go with #1170 ...? What do you think?

Copy link
Copy Markdown
Contributor

@lentschi lentschi Feb 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mjavurek Since there hasn't been an answer to this since May 25, I'm converting this into draft.
This also depends on the outcome of #1252.

Copy link
Copy Markdown
Contributor Author

@mjavurek mjavurek Feb 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Still many people using the foodsoft are not aware that there is this documentation. Most of them understand German. The documentation enhances the usability of the foodsoft for both end users and foodcoop admins. So I would be glad if the link could be included here.
I hoped that somebody would get inspired to translate the German documentation to other languages if it is linked here.

Copy link
Copy Markdown
Contributor

@lentschi lentschi Feb 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see your point and maybe that's a better-than-nothing decision. 👍 But I'd say let's discuss this as a group elsewhere - see #1252 (reply in thread)

Copy link
Copy Markdown
Contributor

@lentschi lentschi Feb 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

-> Converting it back into ready-for-review (but not merging it just yet).


Loading