Chronolog documentation - docs.chronolog.dev#544
Open
Conversation
- Updated Docusaurus configuration to include versioning for documentation, adding support for versions 2.4.0 and 2.3.0. - Created new sidebar structure for improved navigation, replacing the previous tutorial sidebar with distinct sections for Getting Started, Architecture, Client, Plugins, Tutorials, and For Developers. - Added new documentation files for Getting Started, Architecture, Client, For Developers, Plugins, and Tutorials, with caution notices indicating that they are under construction. - Removed outdated intro documentation and reorganized existing content to align with the new structure. - Introduced versioned documentation for 2.3.0, directing users to the 2.4.0 documentation where applicable. - Enhanced homepage features to reflect the new focus on multi-tiered storage, high concurrency, and total ordering capabilities of ChronoLog.
- Updated the HomepageFeatures component to replace SVG icons with emoji representations for better visual appeal. - Added new feature items including "Partial Data Retrieval," "Synchronization-Free," "Auto-Tiering," and "Elastic I/O" to highlight key capabilities. - Improved the layout of feature cards with new CSS styles for better presentation and user experience. - Introduced a new Hero section with a logo, title, and tagline, along with a StatsBar to showcase version and key attributes. - Created an Architecture section to describe the system design and added a Quick Start section for user onboarding. - Implemented a NSF banner to acknowledge funding support and provide a link to the project's GitHub repository.
- Replaced the homepage logo image with a new transparent version for improved visual integration with the layout.
…ge layout - Updated Docusaurus configuration to reflect the new version 2.5.0, including sidebar adjustments and versioning support. - Added new documentation files for Getting Started, Installation, Deployment, and Configuration under version 2.5.0. - Introduced new architecture components and data model documentation to enhance understanding of ChronoLog's structure. - Improved homepage layout with updated styles and a new hero section featuring a background image and enhanced visual elements. - Removed outdated version 2.3.0 documentation and streamlined the navigation for better user experience.
…ation and deployment guides - Added new documentation files for Default Configuration File, Using Configuration Files, Distributed Deployment, and Single Node Deployment. - Updated the Getting Started guide to include new tabs for building from source, downloading tarballs, and using Docker. - Modified Docusaurus configuration to improve sidebar organization, grouping related configuration and deployment topics. - Introduced CSS changes to hide external link icons in the navbar for a cleaner appearance. - Added a new link to the ChronoLog website in the navbar for easier access.
- Standardized section headers in the configuration documentation for better readability. - Revised titles and headings in the Getting Started guide to enhance navigation and user experience. - Improved the structure of the installation guide by clarifying post-build installation steps and customizing installation paths. - Updated code style guidelines to reflect a more organized format and clearer instructions for contributors. - Enhanced contributors guidelines to streamline the Git workflow and project management practices. - Minor adjustments to Docker and performance test tutorials for consistency in formatting and terminology.
…stency - Introduced a new YouTube component for embedding videos in documentation. - Updated titles and labels in the Docker single-node tutorial for clarity. - Revised links in the multi-node and performance test tutorials to ensure consistent navigation. - Enhanced documentation structure for better user experience across version 2.5.0.
- Changed titles and labels in the Docker single-node and multi-node tutorials for consistency and clarity. - Updated references in the multi-node tutorial to align with the new title format. - Enhanced overall documentation coherence across version 2.5.0.
…tups - Removed the outdated Docker category for single-node tutorials. - Added new category and documentation files for multi-node Docker tutorials, including setup and client performance testing. - Introduced a new category for single-node Docker tutorials with corresponding performance test documentation. - Enhanced overall organization and clarity in the Docker tutorial sections for version 2.5.0.
… content updates - Added custom fields to the Docusaurus configuration for version-specific sidebar management. - Introduced new sidebars for user guides, client API, and contributing sections, improving navigation and organization. - Updated sidebar items and links for clarity, including changes to the Getting Started and tutorial links. - Removed outdated installation documentation and restructured content for better coherence across the version. - Added new documentation files for the Python client, CLI tools, and architecture components, enhancing the overall resource availability for users.
…n 2.5.0 - Deleted the 'Building from Source', 'Docker', and 'Pre-Built Binaries' installation guides to streamline content. - Removed the installation category JSON file to reflect the updated documentation structure. - Updated the 'Getting Started' guide to eliminate references to the removed installation options, enhancing clarity and coherence.
…n instructions - Replaced Docker installation instructions with a detailed guide for building from source using Spack. - Added steps for cloning Spack and ChronoLog, installing dependencies, and building the project. - Updated configuration file references and deployment commands for clarity. - Enhanced the overall structure and coherence of the quick start documentation.
- Introduced a new documentation file detailing the testing framework and categories, including unit, integration, communication/overhead, and system/workload tests. - Provided instructions on how to run automated and manual tests using CTest, including examples and explanations for disabled tests. - Enhanced clarity on server tests and their organization within the testing framework, improving overall documentation for contributors and users.
- Introduced new isometric and plain SVG and PNG icons for ChronoGraph, ChronoKeeper, and ChronoPlayer. - Enhanced visual assets to improve documentation and user interface consistency. - Added icons for both isometric and plain styles to provide a comprehensive set of graphics for the components.
- Changed logo and NSF image paths from '/img/' to '/logos/' for consistency across documentation. - Added new internal diagrams for ChronoGrapher, ChronoKeeper, ChronoPlayer, ChronoVisor, and container overview to enhance visual representation of architecture. - Removed outdated images from the static/img directory to streamline asset management.
Replace separate interactive-mode and scripted-mode pages with a unified structure: overview, API reference, and examples. This aligns the CLI section with the standard layout used across other client docs. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Replace per-class pages (client-class, event-class, story-handle, logging) with a unified overview, consolidated API reference, and examples page. Also expands the error-codes reference. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…ples Replace separate reader-api, writer-api, and setup pages with a unified overview, consolidated API reference, examples, and a dedicated error-codes page — matching the structure of other client sections. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
The guides section (reading-events, writing-events, multi-threaded, mpi-distributed, performance-testing) is superseded by the per-client examples pages added in the client docs restructure. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…sections Rename the architecture section from lowercase to titlecase (Architecture) and promote data-model out of it into its own top-level contributing section. Stub pages are replaced with revised content reflecting the current system design. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
… guide Rename the contributing section from development-setup to development and update the category label and sidebar position. Expand the building-for-development page with full documentation of the local_single_user_deploy.sh and cluster deploy scripts, including all flags and a typical developer workflow. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…tion Remove the plugin-development section (placeholder stubs not yet applicable to v2.5.0) and update the guidelines category sidebar position to reflect the new contributing section order. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Fill in previously stubbed configuration pages — client-configuration, network-and-rpc, and performance-tuning — with complete reference content covering all configuration keys, RPC protocol options, and tuning guidance for ChronoLog v2.5.0. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Fill in single-node and multi-node deployment pages with complete step-by-step instructions, configuration examples, and verification steps. Remove the slurm-hpc placeholder which is not yet supported in v2.5.0. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Add a documentation index page under getting-started that maps all v2.5.0 doc pages with completion status. Add the ChronoVisor internal architecture diagram as a static asset. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…ons and prerequisites
…ion, and troubleshooting steps
…, client performance test, and running ChronoLog
…ing page background image
This reverts commit 25acc89.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.