Move Sora details into a note on CLI page #1273
Conversation
|
Preview is available here: |
1 similar comment
|
Preview is available here: |
Oops, I merged this before fixing this. I'll open a change modifying it. @briwylde08 What's the best way to present this in the docs? In general other pages of the docs don't really distinguish between SDF maintained and third party maintained projects. |
|
We don't really do that in the docs at this point, but I think it's probably worth mentioning. We have an issue open where the DevRel team will go through all the various tools listed in the docs to ensure they're being maintained (see it here: #1191). And we can add into the flow to also indicate whether the tool is SDF-maintained or a third party tool. I also think it might be a good idea to have a general disclaimer on the Tools page that says like... "SDF is not responsible for third-party tools not working" but I can work with Wela on some language there. What do you think? |
|
@leighmcculloch that was a long-winded answer but in this particular case I would just add a little language, which I did here: #1275 |
|
Approved the PR, thanks, and 👍🏻 some language or way to signal products are external would be helpful and improve how projects are framed in general. |
What
Move the Sora details into a note block on the CLI documentation page rather than being a section.
Why
It's somewhat confusing going to the page and seeing Sora listed under CLI. It makes it sound like the Sora tool is another CLI, when it's a GUI ontop of the CLI. A note looks to me like a good way to present that information. The page is primarily about the Stellar CLI, and notes are a good way to present ancillary information that take the user away to other related things.