Docs V1
Source of code.kx.com/q
Overview:
The Kdb+ documentation has undergone a significant transformation with the move from the Wiki format to a more organized version using the MkDocs static site generator. This effort brings together years of collective knowledge into a streamlined platform that's easier for users to navigate. As we embrace modernized documentation, the content is meticulously categorized, and terminologies have been refined to enhance clarity and consistency.
This new version is a critical resource for anyone working with the Kdb+ database and the Q language. It offers a comprehensive understanding of the intricacies of Q while making essential information readily accessible, whether you're a seasoned programmer or a newcomer eager to learn.
Features:
-
Organized Structure: The documentation is organized into three main categories—Reference, Cookbook, and Q for Mortals—making navigation intuitive and efficient for different learning needs.
-
Hierarchical Table of Contents: Reference articles are grouped under semantic topics, simplifying the process of finding detailed information about each q function.
-
Consistent Vocabulary: Efforts have been made to distinguish terms like operator and function clearly, eliminating confusion and ensuring users can engage with the material more effectively.
-
User-Friendly Cookbook: The Cookbook section has been migrated to this new format, containing practical examples that guide users through various Q functionalities.
-
Q for Mortals V3 Availability: The entire Q for Mortals V3 is published online in HTML, making it more accessible than its predecessors for in-depth learning.
-
Improved Clarity: Distinctions between glyphs and the functions they denote are made clearer, enhancing users' understanding of both simple and complex concepts in Q.
-
Local Access Option: For those with slow internet connections, there is an option to download the site for offline use, ensuring that essential information is always at hand.
-
Comprehensive Glossary: The documentation includes a glossary of terms, providing further support to users unfamiliar with specific jargon or terminology related to Kdb+ and Q.
- MkDocs
MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.
- Documentation
Documentation themes are built specifically for writing technical and product documentation. They are normally written and maintained in Markdown. The often include a navigation menu, search bar, clear headings, semantic document structure and clean typography.