Docs: Edits to secure cfg.yml nomenclature and new unified cfg.yml file structure
#301
Conversation
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
Signed-off-by: sarah <sarah.scargall@memverge.com>
dxu104
pushed a commit
to dxu104/MemMachine
that referenced
this pull request
Oct 16, 2025
…file structure (MemMachine#301) edits to add cfg.yml nomenclature and new unified cfg.yml file Signed-off-by: sarah <sarah.scargall@memverge.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Purpose of the change
This PR secures cfg.yml as the preferred, or primay file name for our configuration file. It also removes mention of the
.envfile, as it is now unified under cfg.yml. New file structures are also provided in the install guide for both CPU only and GPU installs.Description
Edits to the Install guide to remove now unneeded accordions for cfg.yml and .env file set up, and instead utilized Accordions to break up the CPU-only config example from the GPU example. Also added a Tip with example code of how to pass a configuration file with any name via the MEMORY_CONFIG environmental variable. Updated the Quickstart guide to reflect the cfg.yml nomenclature and added a note/known issue that some versions of the Docker Compose file may use
configuration.ymlas the name, which also works.Fixes/Closes
Fixes #269
Type of change
How Has This Been Tested?
Tested on lab system using
mint dev.[Please delete options that are not relevant.]
Also had windows issues checked by an engineer running on a Windows system (PR #294).
Checklist
Maintainer Checklist
Screenshots/Gifs
N/A
Further comments
The changes in this PR negate changes offered in PR #294, so PR #294 should be closed.