Docs overhaul #55
Merged
Docs overhaul #55
Conversation
This file contains 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
|
My LSP has been broken for a few weeks, so format on save has been hit or miss 🙃 |
|
Alright. I'm thinking:
|
CosmicHorrorDev
added a commit
to CosmicHorrorDev/steamlocate-rs
that referenced
this pull request
Dec 30, 2023
* Finally found an approach to doctest dependecies thats decent * Overhaul landing page * Make github syntax highlighting happy * `cargo fmt` * Overhaul all remaining existing docs * `cargo fmt`
CosmicHorrorDev
added a commit
that referenced
this pull request
Feb 25, 2024
* Bump version * Fully switch from `steamy-vdf` (#9) * feat: Switch appmanifest parsing to use `keyvalues-serde` * feat: Add example to showcase `SteamApp` struct changes * chore: Remove lingering debug `println!()` * fix: Switch some fields to optional * feat: Add `dlcappid` and `LauncherPath` to manifest * fix: Add more missing fields to `SteamApp` * Parsing tweaks * Expose `crate::steamapp` types * Placate clippy * Publish v2.0.0-alpha.0 * Experimental switch to iterator based api (#10) * Hack together experimental API * Get tests passing * Dont use the apps listing from `libraryfolders.vdf` * Fix windows build * Remove caching of values * Placate clippy * Custom error type (#29) * Add additional Steam search paths for Linux (#31) * Add additional Steam search paths for Linux * Fix invalid return type for locate_steam_dir * Fix formatting-related CI fail * impl std::error::Error for Error {} (#32) * Remove steamid-ng feature (keep public API stable) (#33) * Add Snap support for linux (#30) * Get things back to compiling and passing (#38) * Update dependencies (#39) * `cargo upgrade` * `cargo upgrade --incompatible` Everything seems to work fine on my machine. We'll see if CI has anything to say otherwise. We should really beef up our test suite too, but now I'm rambling * Switch tests to run in isolated dummy steam installations (#40) * Switch tests to run in isolated dummy steam installations * Placate clippy * Drastically simplify test helpers (#41) * Run `cargo test` in CI (#42) * Run `cargo test` in CI * `#[ignore]` a couple lingering doctests * Placate clippy (#43) * Placate clippy on more platforms (#44) * Run CI on more platforms/channels (#45) * Bundle existing CI jobs into one * Run CI on more platforms * Use `dtolnay/rust-toolchain` action * Setup CI caching * Run CI on stable and beta * Error cleanup (#46) * `ParseErrorInner` should **not** be part of the public API * `LibaryFolders` -> `LibraryFolders` * Make `Error` non-exhaustive * Add path to io error * Add path to parse error * Remove erroneous print * Fixup error for missing app installation * Unfocused polish (#47) * Refactor `StateFlags` * Restructure public api * `cargo fmt` * Rework `locate()` failures (#49) * Move unsupported OS failure to runtime * Move `locate()` behind a feature flag * Port compat tool (#50) * add method to query configured compatibility tool * Update things to better match new structure --------- Co-authored-by: Jan200101 <[email protected]> * Expose `Library::from_dir()` and `InstallDir::library_paths()` (#51) * Expose `Library::from_dir()` * Add a way to get just library paths * Another round of refactors (#52) * Rename `InstallDir` back to `SteamDir` * `FlagIter` -> `StateFlagIter` * `tests::test_helpers` -> `tests::helpers` * Conditionally ignore `shortcuts_extras` test * Provide more context on installation location failure (#53) * Prepare another alpha (#54) * Bump version to v2.0.0-alpha.1 * Make `App` plain data * Docs overhaul (#55) * Finally found an approach to doctest dependecies thats decent * Overhaul landing page * Make github syntax highlighting happy * `cargo fmt` * Overhaul all remaining existing docs * `cargo fmt` * Prepare the v2.0 beta release (#56) * `SteamDir::from_steam_dir` -> `SteamDir::from_dir` * `shortcuts_extra` is now just part of `steamlocate` * Make `app_id` name more consistent * `cargo fmt` * Update the README * Bump version to v2.0.0-beta.0 * Remove need to use `tempfile` (#57) * Remove need to use `tempfile` * Bump version to v2.0.0-beta.1 * Make `app.last_updated` actually optional (#59) * Fix wasm32 in general (#60) * Alias `lastupdated` for `last_updated` (#61) * Add failing test * Alias `last_updated` to `lastupdated` as well * Bump version to v2.0.0-beta.2 (#62) * Temporarily ignore broken test --------- Co-authored-by: Ethan Green <[email protected]> Co-authored-by: Jan <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Still got a lot more to do, but it's a start