Occasionally, we look to take some of the feedback we get most often and see if we can provide tips to help developers with everyday issues. This week, we had a couple of questions from developers who wanted clarification on the documentation.
We get these kinds of questions all the time, so I’ll summarize what’s available to developers if there are ever questions or comments you want to make on the docs site.
First, we always want to hear feedback generally, and so you have a few ways to reach us at any time.
- Posting on our Slack (which you can find at slack.corda.net).
- Sharing your questions on Corda’s groups.io page.
- Sending an email to firstname.lastname@example.org.
As for our documentation specifically, if you’re looking to let us know about an issue, you can try the following.
- Posting in our public Slack forum for general docs questions.
- For the Corda developer documentation, you’re always welcome to fork the repository and raise a pull request with your suggested change. For example, if you wanted to make a pull request to the docs for Corda 4.7, it’s as simple as editing a markdown file.
- For the Corda developer training, we’ve also open-sourced the code, and you’re able to make changes to that as well. If you’re looking to make a PR to the developer training, that’s also as easy as editing some markdown content.
We get requests to modify the documentation all the time, and it’s always very appreciated. So if you have a suggestion, please let us know or raise a PR!
Hopefully this information is helpful. If you think there’s a way we can communicate better through the documentation, we’d love to hear it. I want to give a special thanks to the technical writers and the documentation team as they do a tremendous amount of work, and we’re fortunate to have them.
If you’d like to see more blog posts like these or have ideas on what we should add, feel free to send a note to email@example.com.
Want to learn more about building awesome blockchain applications on Corda? Be sure to visit corda.net, check out our community page to learn how to connect with other Corda developers, and sign up for one of our newsletters for the latest updates.
— David Awad is a Developer Evangelist at R3, an enterprise blockchain software firm working with a global ecosystem of more than 350 participants across multiple industries from both the private and public sectors to develop on Corda, its open-source blockchain platform, and Corda Enterprise, a commercial version of Corda for enterprise usage.
Follow David on Twitter here.