Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Moving all FCL and BCL documentation into its own section and making it awesome #26

Closed
cartermp opened this issue Aug 10, 2015 · 1 comment
Assignees

Comments

@cartermp
Copy link
Contributor

Currently the primer has a link to a document that isn't in the TOC tree describing briefly what the FCL is, giving a brief overview of the BCL and some examples of what the BCL and FCL contain.

There is also a section called "Base Class Library", which I think is a good candidate for renaming to "Framework Class Library" and modifying it to contain all things FCL, including a link to reference documentation. This would include:

  • Overview of the FCL with a diagram showing its relationship with .NET Managed Langs
    • Section with BCL overview and example of its contents, with link to reference docs
    • Section with other FCL examples, with links to reference docs
  • Article about FCL libraries which are important for cloud devs
    • Snippet about each relevant library for cloud devs with sample code highlighting a common use case in C#, VB, and F#
    • Link to reference docs for each library
    • Links to sample applications or full code samples
  • Article about FCL libraries which are important for mobile devs
    • same as for the cloud devs article
    • Links to the UWP samples and other platform samples

I see value in making it clear to developers the relationship between the libraries and the languages and providing conceptual docs + code samples covering some common scenarios. This is a large enough area that it also demands its own section.

@cartermp cartermp changed the title Moving all FCL and BCL documentation into their own section Moving all FCL and BCL documentation into its own section and making it awesome Aug 10, 2015
@cartermp cartermp self-assigned this Nov 6, 2015
@cartermp
Copy link
Contributor Author

Closing for now; we have more stuff to hash out before we can consider writing this documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant