Docs Update: Incremental Content & Styling Improvements#268
Merged
samcamwilliams merged 71 commits intomainfrom May 20, 2025
Merged
Docs Update: Incremental Content & Styling Improvements#268samcamwilliams merged 71 commits intomainfrom
samcamwilliams merged 71 commits intomainfrom
Conversation
…ate on main cta's
…ra-landing-page-updated-apr-docs
…ra-landing-page-updated-apr-docs
dpshade
force-pushed
the
dpshade/docs-content-styling
branch
from
7e17966 to
23dafc9
Compare
…ate on main cta's
- Synchronize source code documentation with the main branch. - Resolve edoc compilation errors in `hp_opts.erl` by adding backticks to comments. - Correct the destination URL for the hero section button. - Adjust CSS `line-height` for paragraph and list item elements for improved readability.
…n hover, rather than 'dissipate'
- Updated the generated timestamps in `llms-full.txt` and `llms.txt`. - Removed unnecessary `Target` fields in `Send` function calls within `exposing-process-state.md` for clarity. - Enhanced examples in `pathing-in-ao-core.md` and `serverless-decentralized-compute.md` by linking device references for better navigation. - Adjusted formatting in `extending-hyperbeam.md` to maintain consistency and readability.
- Updated the generated timestamps in `llms-full.txt` and `llms.txt`. - Changed the status of the `json` device from Experimental to Stable in `json-at-1-0.md`. - Enhanced serialization examples and clarified HyperPATH chaining in `json-at-1-0.md`. - Corrected references to the `cache` field in `ao-devices.md` and `pathing-in-ao-core.md` for consistency. - Improved formatting and linked device references in `what-is-hyperbeam.md` for better navigation.
- Corrected the reference to the `cache` field in `pathing-in-ao-core.md` and `exposing-process-state.md` for consistency.
dpshade
force-pushed
the
dpshade/docs-content-styling
branch
from
23dafc9 to
f435930
Compare
- Changed the example process ID format in `ao-devices.md` to use `<procId>` for clarity. - Expanded the section on the potential of devices in `ao-devices.md` to outline future possibilities and innovations. - Improved the explanation of HyperBEAM's significance and features in `what-is-hyperbeam.md`, emphasizing its modular architecture and verifiable computation. - Added details about the slot system and HTTP API in `what-is-hyperbeam.md` for better understanding of HyperBEAM's functionality.
- Updated device overviews to include direct links to source code. - Removed status indicators from device documentation for a cleaner presentation. - Enhanced descriptions of device functionalities across multiple files for better understanding.
- Added a comprehensive section on the slot system in `scheduler-at-1-0.md`, outlining its role in organizing and sequencing computation. - Updated `what-is-hyperbeam.md` to reference the new slot system details, enhancing the explanation of the scheduler's functionality.
- Removed unnecessary `[Data Types](#types)` links from multiple source code documentation files for improved clarity and consistency.
…ra-landing-page-updated-apr-docs
dpshade
force-pushed
the
dpshade/docs-content-styling
branch
from
b4e1272 to
e90b566
Compare
…maweb/HyperBEAM into ultra-landing-page-updated-apr-docs
…com/jajablinky/HyperBEAM into dpshade/docs-content-styling
Additionally, cleans-up the module and fixes `push` origin issues.
dpshade
changed the title
…ment This commit improves the security posture of the volume management module by: - Adding explicit exports control via info/1 to prevent unintended API exposure - Adding detailed documentation about security boundaries and safeguards - Requiring explicit configuration of all volume parameters without defaults - Adding comprehensive validation of required parameters with clear error messages - Registering volume@1.0 as an official device in the HyperBEAM ecosystem - Adding structured API documentation with parameter descriptions These changes ensure volume operations are only performed with explicit configuration and prevent potential security risks from misconfiguration or unintended API exposure.
…e_key in unified check
…ructure Convert module to use standard Erlang documentation format with @doc annotations replacing custom -doc and -moduledoc styles. Add proper type specifications and improve function signatures to include error return types. Add new API documentation endpoints (info/1, info/3) that expose device information and available interfaces with parameter details. Refactor volume mounting logic to delegate to dev_volume:mount rather than handling internally. Improve code formatting, event logging consistency, and function organization for better maintainability.
Add utility function to hb_opts module for centralized parameter validation. Replace custom validation logic in dev_volume:mount with this reusable function. Standardize code indentation from tabs to spaces throughout dev_volume module for better consistency. Improve API documentation structure for better readability and consistency.
Add info/1 and info/3 functions to expose device API documentation and capabilities. Replace custom parameter validation logic with the centralized hb_opts:check_required_opts utility function. Fix code indentation throughout the file, converting tabs to spaces for better consistency in the codebase.
Implements RSA-based key encryption for secure volume key transmission. Adds a new public_key endpoint that provides the node's public key, and enhances mount to handle encrypted volume keys.
dpshade
force-pushed
the
dpshade/docs-content-styling
branch
from
94860bf to
4d49fcc
Compare
twilson63
approved these changes
May 16, 2025
twilson63
left a comment
twilson63
left a comment
There was a problem hiding this comment.
LGTM
Doc build instructions work and docs match demo site
|
Only comment is maybe we consider having the document build instructions in a readme in the docs folder versus the main readme. |
…pointing to new file
Author
I agree, change made here 95c7957 |
Collaborator
|
🫡 |
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
6 participants
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.
Documentation Improvements and Automated Deployment
This PR includes incremental improvements to our documentation infrastructure and content:
dps-testing-facilityArNS until we're ready to deploy tohyperbeamSpecific Enhancements
json,lua,message,meta,process,relay,scheduler, andwasm64devicesTo Be Implemented