Skip to content

Commit 806ee9e

Browse files
committed
[GR-32528] Improve How to Contribute to GraalVM Documentation doc.
PullRequest: graal/9382
2 parents e028292 + 34daa28 commit 806ee9e

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
The GraalVM documentation is open source and anyone can contribute to make it perfect and comprehensive.
44

55
The GraalVM documentation is presented in the form of:
6-
* reference documentaiton which includes getting started and user guides, reference manuals, examples, security guidelines
7-
* Javadoc APIS documentaiton for application developers, or those who write Java compatibility tests or seek to re-implement the GraalVM platform
6+
* reference documentation which includes getting started and user guides, reference manuals, examples, security guidelines
7+
* Javadoc APIS documentation for application developers, or those who write Java compatibility tests or seek to re-implement the GraalVM platform
88

99
Here you will find most of the GraalVM documentation sources, in the same hierarchy as displayed on the [GraalVM website](https://www.graalvm.org/docs/introduction/).
1010
The Truffle framework documentation can be found in the [graal/truffle/docs](https://github.com/oracle/graal/tree/master/truffle/docs) folder.
@@ -25,10 +25,10 @@ To update the documentation:
2525
6. Watch your PR for pipeline results
2626

2727
A member from the GraalVM project team will review your PR and merge as appropriate.
28-
There is a CI pipeline that will pick up your change once merged to the master branch, and publish on the website.
28+
There is a CI pipeline which will pick up your change once merged to the master branch, and publish on the website.
2929

3030
The GraalVM core and its projects are hosted in the Oracle organization on GitHub, so we except a contributor to abide by the [Contributor Covenant Code of Conduct](https://www.graalvm.org/community/conduct/).
3131
For more specific guidelines see [Contribute to GraalVM](https://www.graalvm.org/community/contributors/).
3232

33-
Do not hesitate to push fixes to broken links or typos, update an outdated section, propose information if you find it missing, or propose a new feature documentaiton.
33+
Do not hesitate to push fixes to broken links or typos, update an outdated section, propose information if you find it missing, or propose a new feature documentation.
3434
Help us make GraalVM better by improving the existing and contributing new documentation!

0 commit comments

Comments
 (0)