Improve Makefile commands w.r.t. auto-inserted doc links.#50
Merged
DanilaFe merged 6 commits intochapel-lang:mainfrom Jan 22, 2026
Merged
Improve Makefile commands w.r.t. auto-inserted doc links.#50DanilaFe merged 6 commits intochapel-lang:mainfrom
DanilaFe merged 6 commits intochapel-lang:mainfrom
Conversation
Signed-off-by: Danila Fedorin <daniel.fedorin@hpe.com>
Signed-off-by: Danila Fedorin <daniel.fedorin@hpe.com>
Member
|
To avoid retraining users like myself, my strong preference here would be to not remove/rename existing Makefile targets, but to have the new preview mode be called something like |
Signed-off-by: Danila Fedorin <daniel.fedorin@hpe.com>
Signed-off-by: Danila Fedorin <daniel.fedorin@hpe.com>
Signed-off-by: Danila Fedorin <daniel.fedorin@hpe.com>
bradcray
approved these changes
Jan 22, 2026
Member
bradcray
left a comment
There was a problem hiding this comment.
This looks great to me Daniel, thanks! And thanks for updating the docs. Other than the small typo I noted, I think that the OP may be out-of-date w.r.t. what the final makefile command names are? Other than that, this is good to go.
README.md
Outdated
| > ``` | ||
| > | ||
| > The post-processing steps are not currently compatible with live updates, | ||
| > which is why this option is not the default. The command also spawns |
Member
There was a problem hiding this comment.
I think you're missing "a" here in "spawns a server"
Contributor
Author
|
Thanks Brad! I've updated the OP and fixed the typo. Planning to merge once the CI finishes its build. |
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.
This addresses a discussion in which
make previewdidn't preview auto-inserted documentation links. Currently, the auto-inserted links are inserted as a post-processing step. This makes them incompatible with commands that allow hugo to continuously re-render the site and write the results topublic. Moreover, I think we've identified two distinct modes of "preview":For the first case, it makes sense to spawn a watching server, and skip post-processing. In the second case, we want to post-process, and so can't watch the filesystem. This has led me to separate the Makefile commands into
make preview-links(high-fidelity pre-publication preview) andmake watch(live iteration environment, aliasing the oldmake preview). For compatibility, I kept all existing command names as they were.As discussed offline,
make previewdoes not use relative links likemake www, to avoid assuming the blog repo has access to the https://github.com/chapel-lang/chapel-www/ repo on the filesystem.This PR also updates the README with these changes.
Reviewed by @bradcray -- thanks!