all: move all documentation into directory _doc

While at it reformat the README, add section for development, add
link for Go documentation.

6 files changed, 48 insertions, 34 deletions

diff --git a/.gitignore b/.gitignore
index 854ac09..47b1c68 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,6 +1,6 @@
 // SPDX-FileCopyrightText: 2020 M. Shulhan <ms@kilabit.info>
 // SPDX-License-Identifier: GPL-3.0-or-later
-/*.html
+/_doc/*.html
 /cover.html
 /cover.out
 /testdata/*.html
diff --git a/README b/README
index aff9937..52f975d 100644
--- a/README
+++ b/README
@@ -11,14 +11,17 @@ The asciidoctor-go is the Go module to parse the
 https://asciidoctor.org/docs/what-is-asciidoc[AsciiDoc markup^]
 and convert it into HTML5.
 
-== Specifications
+==  Documentation
+
+https://pkg.go.dev/git.sr.ht/~shulhan/asciidoctor-go[Go documentation^].
+
+=== Specifications
 
 During reverse engineering the AsciiDoc markup, we write the syntax, rules,
 and format in
 link:SPECS.html[this document^].
 
-
-== Features
+=== Features
 
 List of available formatting that are supported on current implementation.
 Each supported feature is linked to official
@@ -30,7 +33,7 @@ The numbered one is based on the old documentation.
    meta `doctitle`, `showtitle!` and subtitle.
 ** {url_ref}/document/author-information/[Author information^]
 ** {url_ref}/document/revision-information/[Revision information^]
-** {url_ref}/document/metadata/[Metadata]
+** {url_ref}/document/metadata/[Metadata^]
 * 15. Preamble
 * 16. Sections
 ** 16.1. Titles as HTML headings
@@ -145,9 +148,31 @@ Additional metadata provides by this library,
 * `author_names` - list of author full names separated by comma.
 
 
-==  TODO
+The following markup will not supported because its functionality is duplicate
+with others markup or not secure,
+
+* 14. Header
+** 14.4. Subtitle partitioning.
+   Rationale: duplicate with 14.1.2 the "Main: sub" format
 
-List of features which will be implemented,
+* 23. Tables
+** 23.10. Nested tables.
+   Rationale: nested table is not a good way to present information.
+   Never should it be.
+** Using different cell separator
+
+* 28. Include Directive
+** 28.6. Select Portions of a Document to Include.
+   Rationale: the parser would need to know the language to be included and
+   parse the whole source code to check for comments and tags.
+** 28.8. Include Content from a URI.
+   Rationale: security and unreliable network connections.
+** 28.9. Caching URI Content
+
+
+===  TODO
+
+List of features which may be implemented,
 
 * 16. Sections
 ** 16.9. Section styles
@@ -174,12 +199,12 @@ List of features which will be implemented,
 ** 40.1. Passthrough Macros
 
 
-===  BUGS
+====  BUGS
 
 Unknown.
 
 
-=== ENHANCEMENTS
+==== ENHANCEMENTS
 
 * Create tree that link Include directive.
   Once the included files changes, the parent should be rendered too.
@@ -190,31 +215,7 @@ Unknown.
 --
 
 
-==  Not supported
-
-The following markup will not supported because its functionality is duplicate
-with others markup or not secure,
-
-* 14. Header
-** 14.4. Subtitle partitioning.
-   Rationale: duplicate with 14.1.2 the "Main: sub" format
-
-* 23. Tables
-** 23.10. Nested tables.
-   Rationale: nested table is not a good way to present information.
-   Never should it be.
-** Using different cell separator
-
-* 28. Include Directive
-** 28.6. Select Portions of a Document to Include.
-   Rationale: the parser would need to know the language to be included and
-   parse the whole source code to check for comments and tags.
-** 28.8. Include Content from a URI.
-   Rationale: security and unreliable network connections.
-** 28.9. Caching URI Content
-
-
-==  Miscellaneous
+===  Miscellaneous
 
 link:CHANGELOG.html[Changelog].
 
@@ -223,3 +224,15 @@ library:
 
 * link:testdata/test.exp.html[HTML file generated using asciidoctor^]
 * link:testdata/test.got.html[HTML file using this library^]
+
+
+== Development
+
+https://git.sr.ht/~shulhan/asciidoctor-go[Repository^]::
+Link to the source code.
+
+https://lists.sr.ht/~shulhan/asciidoctor-go[Mailing list^]::
+Link to discussion or where to send the patches.
+
+https://todo.sr.ht/~shulhan/asciidoctor-go[Issues^]::
+Link to open an issue or request for new feature.
diff --git a/index.adoc b/README.adoc
index 100b938..100b938 120000
--- a/index.adoc
+++ b/README.adoc
diff --git a/CHANGELOG.adoc b/_doc/CHANGELOG.adoc
index 86054d8..86054d8 100644
--- a/CHANGELOG.adoc
+++ b/_doc/CHANGELOG.adoc
diff --git a/SPECS.adoc b/_doc/SPECS.adoc
index c3f974c..c3f974c 100644
--- a/SPECS.adoc
+++ b/_doc/SPECS.adoc
diff --git a/_doc/index.adoc b/_doc/index.adoc
new file mode 120000
index 0000000..59a23c4
--- /dev/null
+++ b/_doc/index.adoc
@@ -0,0 +1 @@
+../README
\ No newline at end of file