Repository navigation
Simplify docs navigation and clarify algorithm command examples - #43
Merged
Merged
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
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.
Reorganize the docs around the implementation path: Workflow follows Choosing a profile under Getting started; Building an algorithm contains Prompt builder, Running an algorithm, and Fully manual example. Add Development for core layout, template/shared-package responsibilities, version-4 migration and PyPI publishing. Detailed test catalogues move to Reference.
Replace the unexplained
exampleexecutable with a concretemy_algorithm->my-algorithmmapping, show environment setup, and distinguish the algorithm command from its MEDS-DEV registration name. Align the overview links with the navigation and correct 'a algorithm' throughout the docs. Page URLs remain unchanged.Validation: strict MkDocs build passed; the 19-page offline preview was rebuilt and its internal links verified. This changes documentation only.