Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Figure out how to have an online version of the API Docs that match develop #1902

Closed
tig opened this issue Jul 26, 2022 · 1 comment
Closed
Labels
build-and-deploy Issues regarding to building and deploying Terminal.Gui

Comments

@tig
Copy link
Collaborator

tig commented Jul 26, 2022

With the new branching model, the API Docs at https://gui-cs.github.io/Terminal.Gui/index.html will always represent main, which is correct.

However, when we are developing against develop we also want to be able view/test the API docs that match develop. Using a local docfx --serve version is not sufficient.

The ./README.md in develop should ALSO match develop and link to the develop version of the API Docs.

Related: Issue #1745

And see this: https://tehgm.net/blog/docfx-github-actions/#:~:text=I%20also%20recommend%20that%20you%20work%20on%20minimum,to%20only%20when%20a%20release%20is%20actually%20ready.

@tig tig added the build-and-deploy Issues regarding to building and deploying Terminal.Gui label Jul 26, 2022
@tig tig added this to the v1.7.0 milestone Jul 27, 2022
@tig
Copy link
Collaborator Author

tig commented Jul 28, 2022

This seems very hard to do. I'm not going to attempt it for 1.7.

@tig tig removed this from the v1.7.0 milestone Jul 28, 2022
@tig tig closed this as completed Dec 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build-and-deploy Issues regarding to building and deploying Terminal.Gui
Projects
None yet
Development

No branches or pull requests

1 participant