Achana, Good questions. I've been reorganizing the content a great
deal, and have been meaning to write up some sort of doc roadmap,
which I'll bootstrap here.

The "Platform Guides" are where most of the platform-specific content
lives, in various directories within edge/guide/platforms.  See the
content within the android subdirectory for guidance, and feel free to
adapt it as boilerplate text:

* The index.md should demo how to install any SDK tools that impose a
  dependency on the CLI, and how optionally to compile a Cordova
  project within the SDK. Also, how to set up the platform's emulator.

* config.md: any config.xml options specific to the platform.  For any
  shared with one or more platforms, info goes in
  edge/config_ref/index.md. Use edge/config_ref/images.md for custom
  content about icon/splashscreen image formats.

* tools.md: detail any lower-level non-CLI command-line workflow here.

* plugin.md: how to implement native-side plugin classes, if supported.

* webview.md: how to implement Cordova as a webview within a native
  app, if supported.

* upgrading.md: mostly for pre-CLI tooling, how to modify/restructure
  a project with each Cordova upgrade. (Not applicable for new
  platforms)

These are the basics, but there are a lot of details to getting it
right, such as linking new pages from appropriate spash screens, which
I won't detail here other than to say: OK to add new platform content,
but please do not expose links to it until it's stable from the
end-user POV.

Content about API features currently lives in edge/cordova, but will
soon be split off into separate plugin repos. Three bits of
platform-specific content here:

* Modify each API method/property's "Supported Platforms"

* Add separate "Quirks" sections for partial support

* Modify higher-level "Accessing the Feature" section to specify any
  platform-level config.xml markup the CLI generates.

The table in edge/guide/overview/index.md also shows more accessible
high-level compatibility info. Add a new column for the platform,
applying a custom "data-col" to help consistently position the
columns. Applying a class for each cell of "y", "n", or "p" colors
them green/red/yellow (for partial).

Again, searching for another platform's string helps identify where
you may need to place content:

  $ grep -ri android edge/*

For images, markup such as:
![](img/guide/platforms/ios/file.png)
requires image files mirrored in::
cordova-docs/template/docs/default/img/guide/platforms/ios

You should ignore the various release directories. They're
snap-shotted from "edge" content at each release.

Please also consult the repo's top-level style sheet before adding
content.

Let me know if this makes sense. Would be happy to help.

--Mike Sierra


________________________________________
From: Naik, Archana [[email protected]]
Sent: Thursday, October 10, 2013 2:17 PM
To: [email protected]
Subject: Updating docs

Hi, All

I want to update docs for amazon-fireos platform port for cordova. I have been 
exploring cordova-docs.git repo. I have specific questions about doc changes:
Here are my specific questions:

* What is the process for updating docs? Where do we make changes in edge 
folder?
* Where do we check-in our screenshots(images) for getting started,platform 
guides etc...?
* cordova-docs repo has folders for each release. Do we make changes in all the 
releases that we support?

Thanks
Archana



Reply via email to