Skip to content
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.

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

📝 Punctualize, stylize CLI Guide #1013

Open
JFWooten4 opened this issue Oct 1, 2024 · 0 comments
Open

📝 Punctualize, stylize CLI Guide #1013

JFWooten4 opened this issue Oct 1, 2024 · 0 comments

Comments

@JFWooten4
Copy link
Contributor

What problem does your feature solve?

Re @ElliotFriend in #991, there are a number of pages which are materially-difficult to edit. One such page has an obvious typo whereby there is no period at the end of a sentence, which might be caused by a lack of a functional ✏ Edit this page button. 🤔 Might we make it easier to rectify this and future typos for further contributions, and maybe even entice creative permissionless innovation?1 At a minimum, the diction across the Guides might benefit from consistent "proper" syntax.

What would you like to see?

I can think of two solutions to this challenge. 💭

  1. Preferred Simplicity: 🌌 Change the edit links to reference the actual base page via yarn build settings.

  2. Technical Explainer: 👩‍🏭 Add README explainers to the direct pages to edit in GitHub for all instances2 where this happens.3

What alternatives are there?

We could leave it as challenging as it is to edit a relatively large amount of the Stellar docs. While this could be an easier approach, I think we can look at the state of XRPL's documentation to see just how well the closed-source approach works. Might we make crowdsourced documentation a staple of the network? 🤝

Footnotes

  1. Innovation in the sense that anyone could easily ready, ideate, and upgrade the docs. 💡

  2. This issue presumes we can identify all the places in the code where this phenomenon happens. As I understand it, Tyler originally migrating things, but others likely have a wholistic concept on the infrastructure side. 👨‍👩‍👧‍👦

  3. One option could be to duplicate instructions for each placement in the parent directory of the rendered source host. 📂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Ideas
Development

No branches or pull requests

1 participant