From 08fc4b1ad540f898c3405e7dc649f46af403fc23 Mon Sep 17 00:00:00 2001 From: Jackie Wheeler Date: Mon, 20 Feb 2017 12:44:10 -0800 Subject: [PATCH 1/2] Fix link --- docs/tutorials/first-program.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tutorials/first-program.md b/docs/tutorials/first-program.md index 302290c448f3..13d91d253e1d 100644 --- a/docs/tutorials/first-program.md +++ b/docs/tutorials/first-program.md @@ -116,4 +116,4 @@ Now that you're familiar with running Ballerina in standalone and server mode, u * Read the [Key Concepts](../key-concepts.md) page to familiarize yourself with the rest of the main features you need to know about. * Browse through the [Samples](../samples.md) and use them as templates for your own programs. -* See the [Language Reference](../lang-ref/index.md) for complete information on using the Ballerina language. +* See the [Language Reference](../lang-ref/lang-overview.md) for complete information on using the Ballerina language. From d149587b5b76ef525ce12d13afb2684ebba8ed38 Mon Sep 17 00:00:00 2001 From: Jackie Wheeler Date: Mon, 20 Feb 2017 19:53:11 -0800 Subject: [PATCH 2/2] Latest doc updates (#2069) * Refine TOC Put everything within top-level sections, add link to language specification * Create spec.md * Fix typo * Fix link, add more plugins --- docs/mkdocs.yml | 21 ++++++++++++--------- docs/spec.md | 3 +++ docs/tools.md | 4 +++- 3 files changed, 18 insertions(+), 10 deletions(-) create mode 100644 docs/spec.md diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 2a495bbc267c..77d41dd3145c 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -4,12 +4,13 @@ site_description: Documentation for the Ballerina Programming Language site_author: WSO2, Inc. copyright: 2017 WSO2, Inc. pages: -- Welcome: 'index.md' -- Quick Tour: 'quick-tour.md' -- Write your First Program: 'tutorials/first-program.md' -- Key Concepts: 'key-concepts.md' -- Tools: 'tools.md' -- Samples: 'samples.md' +- Get Started: + - Welcome: 'index.md' + - Quick Tour: 'quick-tour.md' + - Write your First Program: 'tutorials/first-program.md' + - Key Concepts: 'key-concepts.md' + - Tools: 'tools.md' + - Samples: 'samples.md' - Language Reference: - Overview: 'lang-ref/lang-overview.md' - Packaging and Running Programs: 'lang-ref/packaging.md' @@ -28,7 +29,9 @@ pages: - Types and Variables: 'lang-ref/types-variables.md' - Statements: 'lang-ref/statements.md' - Exception Handling: 'lang-ref/exceptions.md' -- Native Functions Reference: 'native-functions.md' -- Architecture: 'architecture.md' -theme: null +- Additional Reference: + - API Documentation: 'native-functions.md' + - Language Specification: 'spec.md' + - Architecture Design Documents: 'architecture.md' theme_dir: ballerina-theme +theme: null diff --git a/docs/spec.md b/docs/spec.md new file mode 100644 index 000000000000..d266c53b0f3d --- /dev/null +++ b/docs/spec.md @@ -0,0 +1,3 @@ +# Language Specification + +If you want to learn more about the inner workings of the Ballerina language itself, you can read the [language specification](https://github.com/ballerinalang/ballerina/blob/master/docs/specification/README.md) in the Ballerina repository on GitHub. diff --git a/docs/tools.md b/docs/tools.md index 2ac983b03af4..3864a999e37e 100644 --- a/docs/tools.md +++ b/docs/tools.md @@ -17,8 +17,10 @@ As you work in one view, the diagrams and code are updated in the other views, a You can use plug-ins to write Ballerina code in your favorite IDE. The following plug-ins are available in Github: * [Atom](https://github.com/ballerinalang/plugin-atom) -* [IntelliJ IDEA] (https://github.com/ballerinalang/plugin-intellij) +* [IntelliJ IDEA](https://github.com/ballerinalang/plugin-intellij) +* [Sublime Text 3](https://github.com/ballerinalang/plugin-sublimetext3) * [Vim](https://github.com/ballerinalang/plugin-vim) +* [Visual Studio Code (VS Code)](https://github.com/ballerinalang/plugin-vscode) ## API documentation generator