changeset 2894:31aa9d097d29

doc: record all the missings and strange bit we know We know the doc is not as fresh as it could be. We make sure the reader is aware too.
author Pierre-Yves David <pierre-yves.david@octobus.net>
date Wed, 30 Aug 2017 18:35:04 +0200
parents 0938f3a09a1e
children e4ee0b6170e9
files docs/index.rst docs/known-doc-issues.rst
diffstat 2 files changed, 46 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/docs/index.rst	Thu Aug 31 17:00:09 2017 +0200
+++ b/docs/index.rst	Wed Aug 30 18:35:04 2017 +0200
@@ -54,6 +54,7 @@
    sharing
    concepts
    from-mq
+   known-doc-issues
 
 .. _`changeset evolution`:
 
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/known-doc-issues.rst	Wed Aug 30 18:35:04 2017 +0200
@@ -0,0 +1,45 @@
+.. Copyright © 2017 Pierre-Yves David <pierre-yves.david@octobus.net>
+
+==============================================
+Known limitations of the current documentation
+==============================================
+
+Missing information
+===================
+
+Some of the *newer* features of evolution might not be reflected in the
+documentation yet. You can directly check the inline documentation of the
+extension itself for fresher details using `hg help -e evolve`.
+
+Known undocumented features are:
+
+ * `hg prev`,
+ * `hg next`,
+ * `hg next --evolve`,
+ * `hg evolve --rev`,
+ * `hg evolve --list`,
+ * `hg obslog`,
+ * `hg split`,
+ * `hg metaedit`,
+ * `hg touch`,
+ * `hg amend --extract`,
+ * `hg pdiff`,
+ * `hg pstatus`,
+ * `hg amend -i`,
+ * various topic related elements (in particular `hg stack`),
+
+Unreferenced Documents
+======================
+
+There are documents with content not linked in the flow of the main
+documentation. Some might be outdated and some are too fresh to be integrated in
+the main flow yet.
+
+.. toctree::
+   :maxdepth: 1
+
+   evolve-faq
+   evolve-good-practice
+   obs-terms
+   tutorials/topic-tutorial
+   tutorials/tutorial