Commit Graph

8 Commits

Author SHA1 Message Date
Jun Wu
55fbb96e31 doc: add QuickStart
Summary: Briefly introduce how to build, test, the directory layout, and coding style.

Reviewed By: markbt, phillco

Differential Revision: D10287048

fbshipit-source-id: b4875c0f1af91b605e328af957d0a357db07b71c
2018-10-24 18:59:14 -07:00
Jun Wu
f24f595b7f doc: remove unhelpful documents
Summary:
Clean up the less helpful documents.
- GeneralDelta: Mostly about migration. We're already migrated.
- RepositoryLayoutRequirements: Mostly about migration. We're already migrated.
- Revlog: Ancient. Not used in production.
- HttpCommandProtocol: Lack of content. Not really used in production.
- SshCommandProtocol: Lack of content.

Reviewed By: phillco

Differential Revision: D10287049

fbshipit-source-id: 54d2b00f146057a8a246c284043adc651db478d8
2018-10-24 18:59:14 -07:00
Jun Wu
187ea10228 doc: put a warning on index page
Summary:
The index is currently useful for easier browsing but otherwise not really
helpful for new developers. I'd like to re-arrange it so it is more friendly to
new developers and do not have incomplete or legacy content. Before I'm able
to get all needed sub pages. Let's put a warning on the index to mark it as
a WIP.

Note: the following commits change the index page, but the changed part is
not final. I plan to rewrite the TOC entirely after more pages are ready.

Reviewed By: markbt

Differential Revision: D10287047

fbshipit-source-id: 11432b3d43b733ccd4040a756c8520878114e027
2018-10-22 16:46:44 -07:00
Jun Wu
0325d0e572 doc: add Markdown support
Summary: Markdown is an alternative to rst.

Reviewed By: markbt

Differential Revision: D10287045

fbshipit-source-id: 6079c20bb59b71ecc785f92a13b7ce6bd1c76f07
2018-10-22 16:46:44 -07:00
Jun Wu
df7cc89b16 doc: add a README
Summary: Add a README to the newdoc directory.

Reviewed By: markbt

Differential Revision: D10287053

fbshipit-source-id: 03ffd080fe9e7d8301eb833ad518099947f7976f
2018-10-22 16:46:43 -07:00
Mark Thomas
ab55bd31c6 newdoc: fix test failures and warnings
Summary:
Remove newdoc from test-check-code - it's a Sphinx project, so MiniRST
checks don't apply.  Also remove the unused imports from the Sphinx config
file.

Reviewed By: farnz

Differential Revision: D9851834

fbshipit-source-id: c17e83fd96d39423eeedfb8a6cfae382f88c4d5f
2018-09-17 08:56:40 -07:00
Mark Thomas
f0957edea7 newdoc: Add documentation from the upstream Mercurial wiki
Summary:
Add information about writing and debugging tests and extensions, as well as
some internals documentation.

Reviewed By: quark-zju

Differential Revision: D9789497

fbshipit-source-id: f1123ea85e76d4ab919dafa26a13142b6cddb3c9
2018-09-17 03:35:14 -07:00
Mark Thomas
7772a2e653 newdoc: add skeleton for Developer Guide
Summary: Add a skeleton for a new Developer Guide.  This is built using Sphinx.

Reviewed By: quark-zju

Differential Revision: D9789496

fbshipit-source-id: d32233e76701789ca5f2327bea270a366776b34e
2018-09-17 03:35:14 -07:00