Index: chrome/common/extensions/docs/server2/README |
diff --git a/chrome/common/extensions/docs/server2/README b/chrome/common/extensions/docs/server2/README |
index 6493111a30b4f378d5d73ba564b6aaf1ff70583a..077326c59afaa8276095277cbfc98c882799d65a 100644 |
--- a/chrome/common/extensions/docs/server2/README |
+++ b/chrome/common/extensions/docs/server2/README |
@@ -35,8 +35,13 @@ Editing Docs |
1. Edit files. |
- - They will mostly be in chrome/common/extensions/api/ or |
- chrome/common/extensions/docs/server2/templates/. |
+ - If you are not updating the static HTML for a docs page, you will most |
+ likely not have to do anything. The docs server will automatically pick |
+ up changes to the JSON or IDL schemas. |
+ |
+ - Otherwise, they will mostly be in chrome/common/extensions/api/ or |
not at google - send to devlin
2012/08/30 02:12:08
what is in chrome/common/extensions/api ?
cduvall
2012/08/30 02:19:11
Done.
|
+ chrome/common/extensions/docs/server2/templates/. See the |
+ "Overview of ./tempalates Directory" section for more information. |
not at google - send to devlin
2012/08/30 02:12:08
templates
cduvall
2012/08/30 02:19:11
Done.
|
- Files in templates directory use the Handlebar template language. It is |
extremely simple. See third_party/handlebar/README.md. |
@@ -49,6 +54,20 @@ Editing Docs |
server will update within 5-10 minutes. |
+Overview of ./templates Directory |
+ |
+The ./templates directory has four subdirectories. |
+ |
+ - intros -> The static content that appears before the API reference on API |
+ pages. |
+ |
+ - articles -> The static content that appears on non-API pages. |
+ |
+ - public -> The top level templates for all pages. |
+ |
+ - private -> Helper templates used in rendering the docs. |
+ |
not at google - send to devlin
2012/08/30 02:12:08
We should explain what a "template" means somewher
cduvall
2012/08/30 02:19:11
line 46
|
+ |
Developing the Server |
You shouldn't need app engine locally to develop the server, preview.py should |