You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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. 💭
Preferred Simplicity: 🌌 Change the edit links to reference the actual base page via yarn build settings.
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
Innovation in the sense that anyone could easily ready, ideate, and upgrade the docs. 💡 ↩
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. 👨👩👧👦 ↩
One option could be to duplicate instructions for each placement in the parent directory of the rendered source host. 📂 ↩
The text was updated successfully, but these errors were encountered:
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. 💭
Preferred Simplicity: 🌌 Change the edit links to reference the actual base page via yarn build settings.
Technical Explainer: 👩🏭 Add
README
explainers to the direct pages to edit in GitHub for all instances2 where this happens.3What 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
Innovation in the sense that anyone could easily ready, ideate, and upgrade the docs. 💡 ↩
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. 👨👩👧👦 ↩
One option could be to duplicate instructions for each placement in the parent directory of the rendered source host. 📂 ↩
The text was updated successfully, but these errors were encountered: