Skip to content

Commit 53f773b

Browse files
committed
Remove links from user docs to contributor docs
1 parent 672a934 commit 53f773b

File tree

3 files changed

+23
-34
lines changed

3 files changed

+23
-34
lines changed

README.md

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,6 @@ There are three ways to install TruffleRuby:
3333
3434
You can use `gem` to install Gems as normal.
3535

36-
You can also build TruffleRuby from source, see the
37-
[building instructions](doc/contributor/workflow.md), and using
38-
[Docker](doc/contributor/docker.md).
39-
4036
Please report any issue you might find on [GitHub](https://github.com/oracle/truffleruby/issues).
4137

4238
## Aim
@@ -58,18 +54,18 @@ important to understand the different configurations of TruffleRuby, as each has
5854
different capabilities and performance characteristics. You should pick the
5955
execution mode that is appropriate for your application.
6056

61-
TruffleRuby by default runs in the *native*
62-
configuration. In this configuration, TruffleRuby is ahead-of-time compiled to a
63-
standalone native executable. This means that you don't need a JVM installed on
64-
your system to use it. The advantage of the native configuration is that it
65-
[starts about as fast as MRI](doc/contributor/native-image.md), it may use less memory,
66-
and it becomes fast in less time. The disadvantage of the native configuration
67-
is that you can't use Java tools like VisualVM, you can't use Java
68-
interoperability, and *peak performance may be lower than on the JVM*. The
69-
native configuration is used by default, but you can also request it using
70-
`--native`. To use polyglot programming with the *native* configuration, you
71-
need to use the `--polyglot` flag. To check you are using the *native*
72-
configuration, `ruby --version` should mention `Native`.
57+
TruffleRuby by default runs in the *native* configuration. In this
58+
configuration, TruffleRuby is ahead-of-time compiled to a standalone native
59+
executable. This means that you don't need a JVM installed on your system to
60+
use it. The advantage of the native configuration is that it starts about as
61+
fast as MRI, it may use less memory, and it becomes fast in less time. The
62+
disadvantage of the native configuration is that you can't use Java tools like
63+
VisualVM, you can't use Java interoperability, and *peak performance may be
64+
lower than on the JVM*. The native configuration is used by default, but you
65+
can also request it using `--native`. To use polyglot programming with the
66+
*native* configuration, you need to use the `--polyglot` flag. To check you
67+
are using the *native* configuration, `ruby --version` should mention
68+
`Native`.
7369

7470
TruffleRuby can also be used in the *JVM* configuration, where it runs as a
7571
normal Java application on the JVM, as any other Java application would. The
@@ -150,8 +146,6 @@ should read our [migration guide](doc/user/jruby-migration.md).
150146
## Documentation
151147

152148
Extensive documentation is available in [`doc`](doc).
153-
[`doc/user`](doc/user) documents how to use TruffleRuby and
154-
[`doc/contributor`](doc/contributor) documents how to develop TruffleRuby.
155149

156150
## Contact
157151

doc/user/deploying.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,17 @@ important to understand the different configurations of TruffleRuby, as each has
1111
different capabilities and performance characteristics. You should pick the
1212
execution mode that is appropriate for your application.
1313

14-
When distributed as part of GraalVM, TruffleRuby by default runs in the *native*
15-
configuration. In this configuration, TruffleRuby is ahead-of-time compiled to a
16-
standalone native executable. This means that you don't need a JVM installed on
17-
your system to use it. The advantage of the native configuration is that it
18-
[starts about as fast as MRI](../contributor/native-image.md), it may use less memory,
19-
and it becomes fast in less time than the *JVM* configuration. The disadvantage
20-
of the native configuration is that you can't use Java tools like VisualVM, you
21-
can't use Java interoperability, and *peak performance may be lower than on the
22-
JVM*. The native configuration is used by default, but you can also request it
23-
using `--native`. To use polyglot programming with the *native* configuration,
24-
you need to use the `--polyglot` flag.
14+
When distributed as part of GraalVM, TruffleRuby by default runs in the
15+
*native* configuration. In this configuration, TruffleRuby is ahead-of-time
16+
compiled to a standalone native executable. This means that you don't need a
17+
JVM installed on your system to use it. The advantage of the native
18+
configuration is that it starts about as fast as MRI, it may use less memory,
19+
and it becomes fast in less time than the *JVM* configuration. The
20+
disadvantage of the native configuration is that you can't use Java tools like
21+
VisualVM, you can't use Java interoperability, and *peak performance may be
22+
lower than on the JVM*. The native configuration is used by default, but you
23+
can also request it using `--native`. To use polyglot programming with the
24+
*native* configuration, you need to use the `--polyglot` flag.
2525

2626
TruffleRuby can also be used in the *JVM* configuration, where it runs as a
2727
normal Java application on the JVM, as any other Java application would. The

doc/user/polyglot.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,6 @@ If you are using the native configuration, you will need to use the `--polyglot`
1212
flag to get access to other languages. The JVM configuration automatically has
1313
access to other languages.
1414

15-
There is also [additional documentation](../contributor/interop.md) that
16-
describes in more depth how polyglot programming in TruffleRuby is implemented
17-
using the Truffle Language Implementation Framework interop API, and exactly
18-
how Ruby is matched to this API.
19-
2015
* [Loading code written in foreign languages](#loading-code-written-in-foreign-languages)
2116
* [Exporting Ruby objects to foreign languages](#exporting-ruby-objects-to-foreign-languages)
2217
* [Importing foreign objects to Ruby](#importing-foreign-objects-to-ruby)

0 commit comments

Comments
 (0)