Update README.md #176
Open
Update README.md #176
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added links o Developer Policies within repo, the developer forum, and added some emphasis to the hosted "version" of this vault because I spent far too long baffled by this github repo, and I wish I had seen those earlier.
joethei
requested changes
Feb 7, 2025
| @@ -2,7 +2,9 @@ | |||
|
|
|||
| This repository contains the vault for the Obsidian Developer Docs. | |||
|
|
|||
| A hosted version of this vault is available at https://docs.obsidian.md/. | |||
| A more accessible version of this vault is available at https://docs.obsidian.md/. (recommended for new contributors) | |||
| [Developer Policies](https://github.com/obsidianmd/obsidian-developer-docs/blob/main/en/Developer%20policies.md) | |||
There was a problem hiding this comment.
That's the wrong link, it should go to the hosted version.
| @@ -2,7 +2,9 @@ | |||
|
|
|||
| This repository contains the vault for the Obsidian Developer Docs. | |||
|
|
|||
| A hosted version of this vault is available at https://docs.obsidian.md/. | |||
| A more accessible version of this vault is available at https://docs.obsidian.md/. (recommended for new contributors) | |||
There was a problem hiding this comment.
The "recommended for new contributors" part is confusing, because you can't contribute to this repo from the docs page.
Also, I would not use "A more accessible version", because it's also a bit confusing.
|
It should go to the hosted version for policies? I didn't even see that
one, found the GitHub vers pretty clear. But can change it tmr
Re: "new contributes" text
Thing is, I would like to contribute, because this is tech I know/need
practice in. I am exactly the target demographic. But I got linked to the
GitHub page from somewhere as a first step, and I think it makes more sense
to refer people to the hosted vers directly there. "Accessible" doesn't
just mean wheelchair friendly - the hosted vers is more accessible to
newcomers is what I mean. My thought is that saying "a hosted version
available here" implies that the hosted version is identical to the GitHub
version - it's not. It's structured much better, and way more friendly to
people unfamiliar with the repo
Verbiage suggestions totally welcome, but as it is, this is is a really
confusing readme
…On Thu, Feb 6, 2025, 8:33 PM Johannes Theiner ***@***.***> wrote:
***@***.**** requested changes on this pull request.
------------------------------
In README.md
<#176 (comment)>
:
> @@ -2,7 +2,9 @@
This repository contains the vault for the Obsidian Developer Docs.
-A hosted version of this vault is available at https://docs.obsidian.md/.
+A more accessible version of this vault is available at https://docs.obsidian.md/. (recommended for new contributors)
+[Developer Policies](https://github.com/obsidianmd/obsidian-developer-docs/blob/main/en/Developer%20policies.md)
That's the wrong link, it should go to the hosted version.
------------------------------
In README.md
<#176 (comment)>
:
> @@ -2,7 +2,9 @@
This repository contains the vault for the Obsidian Developer Docs.
-A hosted version of this vault is available at https://docs.obsidian.md/.
+A more accessible version of this vault is available at https://docs.obsidian.md/. (recommended for new contributors)
The "recommended for new contributors" part is confusing, because you
can't contribute to this repo from the docs page.
Also, I would not use "A more accessible version", because it's also a bit
confusing.
—
Reply to this email directly, view it on GitHub
<#176 (review)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/BBOTCLGXNV6BWFW4LW6QSRL2OP5NRAVCNFSM6AAAAABWUQ3MI6VHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDMMBQGAZTEMJYHA>
.
You are receiving this because you authored the thread.Message ID:
***@***.***>
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added links o Developer Policies within repo, the developer forum, and added some emphasis to the hosted "version" of this vault because I spent far too long baffled by this github repo, and I wish I had seen those earlier.