Various small improvements to the README #110

waldyrious · 2025-02-08T11:17:52+01:00

waldyrious commented

2025-02-08 11:17:52 +01:00

First-time contributor

Minor tweaks to a couple passages in the README :)

waldyrious added 1 commit 2025-02-08 11:17:52 +01:00

Various small improvements to the README f850226110

MrPetovan requested changes 2025-02-08 15:38:22 +01:00

README.md

					
				@ -3,3 +3,3 @@

				This standalone software is meant to provide a global public directory of [Friendica ](https://github.com/friendica/friendica) profiles across nodes.

				This is an opt-in directory, meaning that each node can choose not to submit its profiles to global directories, and each user can individually choose not to be submitted.

				This is an opt-in directory, meaning that each node can choose not to submit its profiles the global directory, and each user can individually choose not to be submitted.

MrPetovan commented

2025-02-08 15:38:19 +01:00

While the Friendica project runs a global directory, it isn't meant to be the only global directory. Still, a node can only publish to a single global directory, which doesn't need to be the one ran by the Friendica team.

I would change the language to "to a global directory" instead.

While the Friendica project runs a global directory, it isn't meant to be the only global directory. Still, a node can only publish to a single global directory, which doesn't need to be the one ran by the Friendica team. I would change the language to "to a global directory" instead.

waldyrious commented

2025-02-11 00:00:40 +01:00

First-time contributor

Hmm, I did wonder if that was the intent, but found it weird for there to be multiple "global" directories, so I picked the phrasing that seemed more intuitive.

Would something like this be acceptable?

This standalone software is meant to provide a public directory of Friendica profiles across nodes.

The inclusion in such a directory is opt-in, meaning that each node can choose not to submit its profiles to a directory, and each user can individually choose not to be submitted.

Hmm, I did wonder if that was the intent, but found it weird for there to be multiple "global" directories, so I picked the phrasing that seemed more intuitive. Would something like this be acceptable? > This standalone software is meant to provide a public directory of [Friendica ](https://github.com/friendica/friendica) profiles across nodes. > > The inclusion in such a directory is opt-in, meaning that each node can choose not to submit its profiles to a directory, and each user can individually choose not to be submitted.

MrPetovan commented

2025-02-11 05:31:41 +01:00

That's good too, the reason for the "global" qualifier is that each node maintain its own "local" directory of local users (at /directory on your node)

That's good too, the reason for the "global" qualifier is that each node maintain its own "local" directory of local users (at `/directory` on your node)

waldyrious commented

2025-02-11 14:55:05 +01:00

First-time contributor

Oh, thanks for the context! Yeah, I can see the logic, but indeed the term has the unfortunate connotation of implying there's a single overall aggregate directory. I'll try to incorporate this info in the README without using the word "global" :)

👍 1

This pull request can be merged automatically.

You are not authorized to merge this pull request.

View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.

git fetch -u readme-tweaks:waldyrious-readme-tweaks

git checkout waldyrious-readme-tweaks

Merge

Merge the changes and update on Forgejo.

Warning: The "Autodetect manual merge" setting is not enabled for this repository, you will have to mark this pull request as manually merged afterwards.

git checkout stable

git merge --no-ff waldyrious-readme-tweaks

git checkout waldyrious-readme-tweaks

git rebase stable

git checkout stable

git merge --ff-only waldyrious-readme-tweaks

git checkout waldyrious-readme-tweaks

git rebase stable

git checkout stable

git merge --no-ff waldyrious-readme-tweaks

git checkout stable

git merge --squash waldyrious-readme-tweaks