Merge pull request #33 from metaborg/split-lang-spec-and-dev-docs

Reorganize documentation to improve menu discoverability
metaborg · Apr 14, 2020 · d318c6c · d318c6c
2 parents 92e46a0 + ff4b5eb
commit d318c6c
Show file tree

Hide file tree

Showing 47 changed files with 40 additions and 24 deletions.
diff --git a/index.rst b/index.rst
@@ -32,7 +32,7 @@ The Spoofax Language Workbench
 .. toctree::
    :hidden:
    :maxdepth: 2
-   :caption: Reference Manual
+   :caption: Language Definition Reference
 
    source/langdev/meta/lang/tour/index
    source/langdev/meta/lang/aterm/index
@@ -43,9 +43,15 @@ The Spoofax Language Workbench
    Transformation with Stratego <source/langdev/meta/lang/stratego/index>
    Dynamic Semantics with DynSem <source/langdev/meta/lang/dynsem/index>
    Editor Services with ESV <source/langdev/meta/lang/esv>
-
    Language Testing with SPT <source/langdev/meta/lang/spt/index>
-   Building Languages <source/langdev/manual/index>
+
+.. toctree::
+   :hidden:
+   :maxdepth: 2
+   :caption: Language Development Reference
+
+   Build and Develop Languages <source/langdev/build/index>
+   Configure Languages <source/langdev/config/index>
    Running Languages from Command-line <source/sunshine/manual/index>
    Programmatic API <source/core/manual/index>
    Developing Spoofax <source/dev/index>

diff --git a/source/core/manual/service.rst b/source/core/manual/service.rst
@@ -174,7 +174,7 @@ Configuration
 
 Configuration services provide read and write access to project and language component configuration at runtime.
 
-See the :doc:`language development manual on configuration </source/langdev/manual/config>` for documentation about the Spoofax language specification configuration, which is a superset of the language specification, component, and project configuration.
+See the :doc:`language development manual on configuration </source/langdev/config/index>` for documentation about the Spoofax language specification configuration, which is a superset of the language specification, component, and project configuration.
 
 .. describe:: Project configuration
 
@@ -244,7 +244,7 @@ Configuration
 ^^^^^^^^^^^^^
 
 Configuration services for language specifications.
-See the :doc:`language development manual on configuration </source/langdev/manual/config>` for documentation about the Spoofax language specification configuration.
+See the :doc:`language development manual on configuration </source/langdev/config/index>` for documentation about the Spoofax language specification configuration.
 
 .. describe:: Language specification configuration
 

diff --git a/source/langdev/manual/ci.md → source/langdev/build/ci.md b/source/langdev/manual/ci.md → source/langdev/build/ci.md
diff --git a/...al/env/intellij/existing-language-spec.md → ...ld/env/intellij/existing-language-spec.md b/...al/env/intellij/existing-language-spec.md → ...ld/env/intellij/existing-language-spec.md
diff --git a/...v/manual/env/intellij/existing-project.md → ...ev/build/env/intellij/existing-project.md b/...v/manual/env/intellij/existing-project.md → ...ev/build/env/intellij/existing-project.md
diff --git a/.../manual/env/intellij/img/button_minus.png → ...v/build/env/intellij/img/button_minus.png b/.../manual/env/intellij/img/button_minus.png → ...v/build/env/intellij/img/button_minus.png
diff --git a/...v/manual/env/intellij/img/button_plus.png → ...ev/build/env/intellij/img/button_plus.png b/...v/manual/env/intellij/img/button_plus.png → ...ev/build/env/intellij/img/button_plus.png
diff --git a/...env/intellij/img/dialog_selectjdkhome.png → ...env/intellij/img/dialog_selectjdkhome.png b/...env/intellij/img/dialog_selectjdkhome.png → ...env/intellij/img/dialog_selectjdkhome.png
diff --git a/...llij/img/dialog_selectmetaborgsdkhome.png → ...llij/img/dialog_selectmetaborgsdkhome.png b/...llij/img/dialog_selectmetaborgsdkhome.png → ...llij/img/dialog_selectmetaborgsdkhome.png
diff --git a/...nual/env/intellij/img/import_langspec.png → ...uild/env/intellij/img/import_langspec.png b/...nual/env/intellij/img/import_langspec.png → ...uild/env/intellij/img/import_langspec.png
diff --git a/...j/img/import_langspec_existingsources.png → ...j/img/import_langspec_existingsources.png b/...j/img/import_langspec_existingsources.png → ...j/img/import_langspec_existingsources.png
diff --git a/...llij/img/import_langspec_projectroots.png → ...llij/img/import_langspec_projectroots.png b/...llij/img/import_langspec_projectroots.png → ...llij/img/import_langspec_projectroots.png
diff --git a/...anual/env/intellij/img/importproject1.png → ...build/env/intellij/img/importproject1.png b/...anual/env/intellij/img/importproject1.png → ...build/env/intellij/img/importproject1.png
diff --git a/...nual/env/intellij/img/install_plugin1.png → ...uild/env/intellij/img/install_plugin1.png b/...nual/env/intellij/img/install_plugin1.png → ...uild/env/intellij/img/install_plugin1.png
diff --git a/...nual/env/intellij/img/install_plugin2.png → ...uild/env/intellij/img/install_plugin2.png b/...nual/env/intellij/img/install_plugin2.png → ...uild/env/intellij/img/install_plugin2.png
diff --git a/...nual/env/intellij/img/install_plugin3.png → ...uild/env/intellij/img/install_plugin3.png b/...nual/env/intellij/img/install_plugin3.png → ...uild/env/intellij/img/install_plugin3.png
diff --git a/...intellij/img/messagebox_configurejava.png → ...intellij/img/messagebox_configurejava.png b/...intellij/img/messagebox_configurejava.png → ...intellij/img/messagebox_configurejava.png
diff --git a/...v/manual/env/intellij/img/newproject1.png → ...ev/build/env/intellij/img/newproject1.png b/...v/manual/env/intellij/img/newproject1.png → ...ev/build/env/intellij/img/newproject1.png
diff --git a/...tellij/img/newproject_langspec_newsdk.png → ...tellij/img/newproject_langspec_newsdk.png b/...tellij/img/newproject_langspec_newsdk.png → ...tellij/img/newproject_langspec_newsdk.png
diff --git a/...newprojectform_checkmetaborgframework.png → ...newprojectform_checkmetaborgframework.png b/...newprojectform_checkmetaborgframework.png → ...newprojectform_checkmetaborgframework.png
diff --git a/...ij/img/newprojectform_javaprojectname.png → ...ij/img/newprojectform_javaprojectname.png b/...ij/img/newprojectform_javaprojectname.png → ...ij/img/newprojectform_javaprojectname.png
diff --git a/...g/newprojectform_langspec_inputfields.png → ...g/newprojectform_langspec_inputfields.png b/...g/newprojectform_langspec_inputfields.png → ...g/newprojectform_langspec_inputfields.png
diff --git a/...g/newprojectform_langspec_projectname.png → ...g/newprojectform_langspec_projectname.png b/...g/newprojectform_langspec_projectname.png → ...g/newprojectform_langspec_projectname.png
diff --git a/...rojectform_langspec_selectmetaborgsdk.png → ...rojectform_langspec_selectmetaborgsdk.png b/...rojectform_langspec_selectmetaborgsdk.png → ...rojectform_langspec_selectmetaborgsdk.png
diff --git a/...nv/intellij/img/newprojectform_newsdk.png → ...nv/intellij/img/newprojectform_newsdk.png b/...nv/intellij/img/newprojectform_newsdk.png → ...nv/intellij/img/newprojectform_newsdk.png
diff --git a/...ntellij/img/newprojectform_newsdkmenu.png → ...ntellij/img/newprojectform_newsdkmenu.png b/...ntellij/img/newprojectform_newsdkmenu.png → ...ntellij/img/newprojectform_newsdkmenu.png
diff --git a/...j/img/newprojectform_newsdkmenu_small.png → ...j/img/newprojectform_newsdkmenu_small.png b/...j/img/newprojectform_newsdkmenu_small.png → ...j/img/newprojectform_newsdkmenu_small.png
diff --git a/.../img/newprojectform_selectmetaborgsdk.png → .../img/newprojectform_selectmetaborgsdk.png b/.../img/newprojectform_selectmetaborgsdk.png → .../img/newprojectform_selectmetaborgsdk.png
diff --git a/...ewprojectform_selectmetaborgsdk_small.png → ...ewprojectform_selectmetaborgsdk_small.png b/...ewprojectform_selectmetaborgsdk_small.png → ...ewprojectform_selectmetaborgsdk_small.png
diff --git a/...img/projectstructure_addmetaborgfacet.png → ...img/projectstructure_addmetaborgfacet.png b/...img/projectstructure_addmetaborgfacet.png → ...img/projectstructure_addmetaborgfacet.png
diff --git a/...ellij/img/projectstructure_newsdkmenu.png → ...ellij/img/projectstructure_newsdkmenu.png b/...ellij/img/projectstructure_newsdkmenu.png → ...ellij/img/projectstructure_newsdkmenu.png
diff --git a/...j/img/projectstructure_setmetaborgsdk.png → ...j/img/projectstructure_setmetaborgsdk.png b/...j/img/projectstructure_setmetaborgsdk.png → ...j/img/projectstructure_setmetaborgsdk.png
diff --git a/...ij/img/settings_metaborglanguages_add.png → ...ij/img/settings_metaborglanguages_add.png b/...ij/img/settings_metaborglanguages_add.png → ...ij/img/settings_metaborglanguages_add.png
diff --git a/source/langdev/manual/env/intellij/index.rst → source/langdev/build/env/intellij/index.rst b/source/langdev/manual/env/intellij/index.rst → source/langdev/build/env/intellij/index.rst
diff --git a/...gdev/manual/env/intellij/installation.rst → ...ngdev/build/env/intellij/installation.rst b/...gdev/manual/env/intellij/installation.rst → ...ngdev/build/env/intellij/installation.rst
diff --git a/...env/intellij/load-and-unload-languages.md → ...env/intellij/load-and-unload-languages.md b/...env/intellij/load-and-unload-languages.md → ...env/intellij/load-and-unload-languages.md
diff --git a/...angdev/manual/env/intellij/module-sdk.txt → ...langdev/build/env/intellij/module-sdk.txt b/...angdev/manual/env/intellij/module-sdk.txt → ...langdev/build/env/intellij/module-sdk.txt
diff --git a/.../manual/env/intellij/new-langspec-sdk.txt → ...v/build/env/intellij/new-langspec-sdk.txt b/.../manual/env/intellij/new-langspec-sdk.txt → ...v/build/env/intellij/new-langspec-sdk.txt
diff --git a/.../manual/env/intellij/new-language-spec.md → ...v/build/env/intellij/new-language-spec.md b/.../manual/env/intellij/new-language-spec.md → ...v/build/env/intellij/new-language-spec.md
diff --git a/...v/manual/env/intellij/new-project-sdk.txt → ...ev/build/env/intellij/new-project-sdk.txt b/...v/manual/env/intellij/new-project-sdk.txt → ...ev/build/env/intellij/new-project-sdk.txt
diff --git a/...angdev/manual/env/intellij/new-project.md → ...langdev/build/env/intellij/new-project.md b/...angdev/manual/env/intellij/new-project.md → ...langdev/build/env/intellij/new-project.md
diff --git a/source/langdev/build/index.rst b/source/langdev/build/index.rst
@@ -0,0 +1,12 @@
+===================================
+Build and Develop Language Projects
+===================================
+
+This is the reference manual on build and development tools for Spoofax language development.
+
+.. toctree::
+   :maxdepth: 2
+   :numbered:
+
+   ci
+   env/intellij/index
diff --git a/source/langdev/config/index.rst b/source/langdev/config/index.rst
@@ -0,0 +1,12 @@
+=============================
+Configuring Language Projects
+=============================
+
+This is the reference manual on configuring Spoofax language projects.
+
+.. toctree::
+   :maxdepth: 2
+   :numbered:
+
+   reference
+   language-extension
diff --git a/source/langdev/manual/language-extension.md → source/langdev/config/language-extension.md b/source/langdev/manual/language-extension.md → source/langdev/config/language-extension.md
diff --git a/source/langdev/manual/config.rst → source/langdev/config/reference.rst b/source/langdev/manual/config.rst → source/langdev/config/reference.rst
@@ -1,8 +1,8 @@
 .. highlight:: yaml
 
-=============
-Configuration
-=============
+=======================
+Configuration Reference
+=======================
 
 Configuration is specified in the :file:`metaborg.yaml` file at the root of the project.
 

diff --git a/source/langdev/manual/index.rst b/source/langdev/manual/index.rst
diff --git a/source/release/migrate/2.0.0.md b/source/release/migrate/2.0.0.md
@@ -162,7 +162,7 @@ Unfortunately, not all required conversions can be done automatically. Do the fo
 #### Project configuration
 
 Most of the project configuration is now in the <span class='file'>metaborg.yaml</span> file.
-The [manual page on configuration](../../langdev/manual/config.rst) lists all configuration options.
+The [manual page on configuration](../../langdev/config/reference.md) lists all configuration options.
 
 * Add/remove compile and source dependencies as needed.
 * Add build configuration, such as Stratego compiler arguments, SDF compiler arguments, external def files, and external JAR files.
@@ -279,7 +279,7 @@ build:
     target: package-xml
 ```
 
-See the [manual page on configuration](../../langdev/manual/config.rst) for more information about configuring Ant build steps.
+See the [manual page on configuration](../../langdev/config/reference.md) for more information about configuring Ant build steps.
 
 #### Eclipse plugin