The docs site is somewhat new - a migration from the old wordpress site. The migration did introduce some issues that we need to fix. The following lists all of the types of things that should be fixed:
Broken Links
Lots of links still point to wordpress, or were not converted correctly in the migration. You can tell a link is bad by following it, or by highlighting it in edit mode in gitbook. If it starts with "https://github" then it is probably bad:
Removal of [subpages ] tag
This was needed in wordpress, but no longer needed here:
Convert all code blocks to C# code blocks
Rename "Glue" to "FlatRedBall Editor" or similar
Glue is the old name for the FlatRedBall Editor. To avoid confusion (people often called Glue "FlatRedBall") we are removing the term "Glue" and replacing it with variants of FlatRedBall.
The term FlatRedBall can refer to:
A general umbrella term for all things related to developing with FlatRedBall
Specifically the FlatRedBall Engine, which is the .dll and the set of classes which are not generated which the developer can interact with in code
The Editor, which is the visual tool used to create and organize projects
The term FlatRedBall and FRB can be used interchangeably in documentation. Use FRB or FlatRedBall when it is clear that the documentation is referring to the editor. If there is ambiguity, such as if the documentation is discussing both code and the editor, use "the FlatRedBall Editor" or "the FRB Editor" to clearly reference the editor and not the engine.
Note, the term "Glue" is still acceptable when discussing the writing of plugins. The reason is because the term "Glue" is still used heavily in code, so if someone is writing plugins, then they will encounter this term. We also use the term "Glue" in discussions with people who have extensive experience with FRB, or who have written plugins.
Replace Screenshots of old FRB Editor
The FRB Editor UI has changed over the years. Some documentation still has old FRB Editor shots.
Look for:
Black background tree view
Tree view on the right-side of the screen
PascalCase Titles
Some pages are still lower-case. If the title is a programming term such as FlatRedBall, then PascalCase it. If the title is a phrase, then use the Chicago capitalization rules:
blueee04
commented
7 months ago
The docs site is somewhat new - a migration from the old wordpress site. The migration did introduce some issues that we need to fix. The following lists all of the types of things that should be fixed:
Broken Links
Lots of links still point to wordpress, or were not converted correctly in the migration. You can tell a link is bad by following it, or by highlighting it in edit mode in gitbook. If it starts with "https://github" then it is probably bad:
Removal of [subpages ] tag
This was needed in wordpress, but no longer needed here:
Convert all code blocks to C# code blocks
Rename "Glue" to "FlatRedBall Editor" or similar
Glue is the old name for the FlatRedBall Editor. To avoid confusion (people often called Glue "FlatRedBall") we are removing the term "Glue" and replacing it with variants of FlatRedBall.
The term FlatRedBall can refer to:
The term FlatRedBall and FRB can be used interchangeably in documentation. Use FRB or FlatRedBall when it is clear that the documentation is referring to the editor. If there is ambiguity, such as if the documentation is discussing both code and the editor, use "the FlatRedBall Editor" or "the FRB Editor" to clearly reference the editor and not the engine.
Note, the term "Glue" is still acceptable when discussing the writing of plugins. The reason is because the term "Glue" is still used heavily in code, so if someone is writing plugins, then they will encounter this term. We also use the term "Glue" in discussions with people who have extensive experience with FRB, or who have written plugins.
Replace Screenshots of old FRB Editor
The FRB Editor UI has changed over the years. Some documentation still has old FRB Editor shots.
Look for:
PascalCase Titles
Some pages are still lower-case. If the title is a programming term such as FlatRedBall, then PascalCase it. If the title is a phrase, then use the Chicago capitalization rules:
https://capitalizemytitle.com/style/chicago