|author||Andrew Wetmore <firstname.lastname@example.org>||Fri Dec 28 08:56:16 2018 -0400|
|committer||GitHub <email@example.com>||Fri Dec 28 08:56:16 2018 -0400|
Update Strands and Beads.md small changes; merging while I wait for team feedback to some questions.
We have three main audiences:
We can't assume that everybody understands the conversational shorthand Flex veterans use. Write for a person of good will who is reading to find out, and who wants to get to the next needed nugget of knowledge soon so they can go and make progress on the app they are working on.
Each .md page starts with “front matter” structured like this:
--- # Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. layout: docpage title: README ---
Use HTML comments at the top of the document for any explanatory notes for the doc team (
<!-- Not finished yet - Andrew -->) and for provenance when adapting existing material for Royale purposes (
<!-- Created by Peter Ent, modified by Tom Chiverton, as part of FlexJS documentation-->).
%20statements, and add the markdown specification. The file name should be “important-thing.md”, not “Another%20Important%20Thing.md”, “AnotherImportantThing.md”, or “Another_important_thing.md”. This is important for SEO, human readability, and readability by assistive devices.
In the .md files, links have to be a full path without the leading slash. So to link to the published, HTML, version of /Welcome/Features/AS3.md, you would use
without the leading “/”. Links are case-sensitive, and you need to insert
%20 for any space that appears in the target file's name. Check the guidance about file names, above.
When linking to locations not in the help-docs stack, including other pages in the Royale website, clicking the link should open a new browser window or tab so the reader does not lose their place in the help docs. If you want to use MarkDown, set the link like this:
You can also use straight HTML for these links, like this:
<a href="https://flex.apache.org" target="_blank">Apache Flex</a>