Skip to content

Commit 700ce19

Browse files
fwsGonzofwsGonzo
authored
Merge pull request #5 from imbev/main
[WIP] Reorganize sections, add Getting Started section, add host/guest language sections
2 parents 34bc075 + 9c0af3d commit 700ce19

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+320
-7
lines changed

‎docs/benchmarks/_category_.json

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"label": "Benchmarks",
3+
"collapsed": true,
4+
"position": 4,
5+
"link": {
6+
"type": "generated-index",
7+
"description": "Learn more about libriscv performance."
8+
}
9+
}

‎docs/performance/latency.md renamed to ‎docs/benchmarks/latency.md

+1-1

‎docs/performance/performance.md renamed to ‎docs/benchmarks/performance.md

+1-1

‎docs/emulator/_category_.json renamed to ‎docs/concepts/_category_.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
2-
"label": "Emulator",
3-
"collapsed": false,
2+
"label": "Concepts",
3+
"collapsed": true,
44
"position": 3,
55
"link": {
66
"type": "generated-index",

‎docs/emulator/execution.md renamed to ‎docs/concepts/execution.md

‎docs/emulator/syscalls.md renamed to ‎docs/concepts/syscalls.md

‎docs/emulator/vmcalls.md renamed to ‎docs/concepts/vmcalls.md

‎docs/performance/_category_.json renamed to ‎docs/getting_started/_category_.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"label": "Performance",
2+
"label": "Getting Started",
33
"collapsed": false,
44
"position": 2,
55
"link": {

‎docs/getting_started/guest.md

+44

‎docs/getting_started/host.md

+113

‎docs/getting_started/intro.md

+5

‎docs/guest_langs/_category_.json

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"label": "Guest Languages",
3+
"collapsed": false,
4+
"position": 6,
5+
"link": {
6+
"type": "generated-index",
7+
"description": "Guest programs can be written in any language supporting riscv64-unknown-elf-gcc, riscv64-unknown-linux-gnu, and similar target platforms."
8+
}
9+
}

‎docs/guest_langs/c_lang.md

+57

‎docs/host_langs/_category_.json

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"label": "Host Languages",
3+
"collapsed": false,
4+
"position": 5,
5+
"link": {
6+
"type": "generated-index",
7+
"description": "Host programs using libriscv can be written in multiple languages. C++ is best supported, other languages may have a relatively incomplete API."
8+
}
9+
}

‎docs/host_langs/c_lang.md

+29

‎docs/host_langs/cpp_lang.md

+29

‎docs/host_langs/godot_integration/_category_.json

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"label": "GDScript",
3+
"collapsed": true,
4+
"position": 2,
5+
"link": {
6+
"type": "generated-index",
7+
"description": "GDScript is a scripting language to be used with the Godot Game engine."
8+
}
9+
}

‎docs/godot_docs/_category_.json renamed to ‎docs/host_langs/godot_integration/godot_docs/_category_.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"label": "Godot Sandbox Docs",
33
"collapsed": false,
4-
"position": 5,
4+
"position": 3,
55
"link": {
66
"type": "generated-index",
77
"description": "Learn more about about the Godot sandbox."

‎docs/godot_docs/bintr.md renamed to ‎docs/host_langs/godot_integration/godot_docs/bintr.md

‎docs/godot_docs/cmake.md renamed to ‎docs/host_langs/godot_integration/godot_docs/cmake.md

‎docs/godot_docs/cppapi.md renamed to ‎docs/host_langs/godot_integration/godot_docs/cppapi.md

‎docs/godot_docs/cppexamples.md renamed to ‎docs/host_langs/godot_integration/godot_docs/cppexamples.md

‎docs/godot_docs/design.md renamed to ‎docs/host_langs/godot_integration/godot_docs/design.md

‎docs/godot_docs/image-1.png renamed to ‎docs/host_langs/godot_integration/godot_docs/image-1.png

File renamed without changes.

‎docs/godot_docs/image-2.png renamed to ‎docs/host_langs/godot_integration/godot_docs/image-2.png

File renamed without changes.

‎docs/godot_docs/image-3.png renamed to ‎docs/host_langs/godot_integration/godot_docs/image-3.png

File renamed without changes.

‎docs/godot_docs/image-4.png renamed to ‎docs/host_langs/godot_integration/godot_docs/image-4.png

File renamed without changes.

‎docs/godot_docs/image-5.png renamed to ‎docs/host_langs/godot_integration/godot_docs/image-5.png

File renamed without changes.

‎docs/godot_docs/image-6.png renamed to ‎docs/host_langs/godot_integration/godot_docs/image-6.png

File renamed without changes.

‎docs/godot_docs/image.png renamed to ‎docs/host_langs/godot_integration/godot_docs/image.png

File renamed without changes.

‎docs/godot_docs/libraries.md renamed to ‎docs/host_langs/godot_integration/godot_docs/libraries.md

‎docs/godot_docs/memory.md renamed to ‎docs/host_langs/godot_integration/godot_docs/memory.md

‎docs/godot_docs/modding.md renamed to ‎docs/host_langs/godot_integration/godot_docs/modding.md

‎docs/godot_docs/profiling_debugging.md renamed to ‎docs/host_langs/godot_integration/godot_docs/profiling_debugging.md

‎docs/godot_docs/restrictions.md renamed to ‎docs/host_langs/godot_integration/godot_docs/restrictions.md

‎docs/godot_docs/sugar.md renamed to ‎docs/host_langs/godot_integration/godot_docs/sugar.md

‎docs/godot_docs/unboxed_arguments.md renamed to ‎docs/host_langs/godot_integration/godot_docs/unboxed_arguments.md

‎docs/godot_intro/_category_.json renamed to ‎docs/host_langs/godot_integration/godot_intro/_category_.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"label": "Godot Getting Started",
33
"collapsed": false,
4-
"position": 4,
4+
"position": 2,
55
"link": {
66
"type": "generated-index",
77
"description": "Learn more about how to use sandboxing in Godot."

‎docs/godot_intro/cppprogram.md renamed to ‎docs/host_langs/godot_integration/godot_intro/cppprogram.md

‎docs/godot_intro/intro.md renamed to ‎docs/host_langs/godot_integration/godot_intro/intro.md

‎docs/godot_intro/rustprogram.md renamed to ‎docs/host_langs/godot_integration/godot_intro/rustprogram.md

‎docs/godot_intro/sandbox.md renamed to ‎docs/host_langs/godot_integration/godot_intro/sandbox.md

0 commit comments

Comments
 (0)