Sandcastle Assist project aims to provide a .NET library that will make it easier to use the Sandcastle tool, a documentation compiler for managed libraries from Microsoft.
Microsoft's
Sandcastle is a set of help or documentation compilers for managed class libraries. It enables managed class library developers to create accurate, informative documentation with a common look and feel.
The Sandcastle Assist project will provide extension libraries and utility classes to help make the process of creating a documentation with the Sandcastle tools easier. It will be the Sandcastle SDK, and we will work hard to make it good!
Development Roadmap
We have made progress in most of our projects, especially the more time consuming
Sandcastle Workshop. We have started drawing up the roadmap, and we invite you to work with us to realize it. We welcome any feedback; suggestions and criticisms (please feel free to judge us, and let us know how we are doing), and your precious time in testing.
See the Roadmap Wiki Page...
Announcements
November 10, 2009 - Development Roadmap
July 17, 2009 - Sandcastle Assist BlogWe are now blogging on this project:
http://sandcastleassist.blogspot.com/More Announcements...
Main Packages
The Sandcastle Assist will consists of a number of packages or assemblies. Currently, we are working on the following:
- Sandcastle Common: All the base classes, the utilities classes, configurations classes and more...
- Sandcastle Builders: A complete library for building reference and conceptual documentations. It is a task based build library, and will expand to support both MSBuild and Team Build.
- Sandcastle Build Components: A number of custom build components, which enhance and improve the documentation build system.
- Sandcastle Controls: A number of custom controls to help editing various parts of the Sandcastle configurations and settings.
- Sandcastle Helpers: A simple but complete help builder library - Lite Builders!
Application Packages
The Sandcastle Assist will provide ready to use applications for help developments.
- Sandcastle Workshop: A complete Integrated Developer Environment (IDE) for creating and compiling help systems using the Sandcastle compiler. This will be the Sandcastle equivalent of the HtmlHelp Workshop.
Tools Packages
Finally, Sandcastle Assist will provide some utility and tool packages that might be useful to the help developer. These are separated from the main and other packages because of differences in licensing; most of the utilities are based on existing libraries that are under LGPL. These will be place in the
Development folder in the source control, and will be under the
LGPL license.