-
Notifications
You must be signed in to change notification settings - Fork 2.1k
[documentation] re-structure table of contents #4074
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
Conversation
/azp run mrtk_docs |
Azure Pipelines successfully started running 1 pipeline(s). |
Waiting on docs run, changes seem okay. |
Can you fix the doc build breaks please: Build failed. |
/azp run mrtk_docs |
Azure Pipelines successfully started running 1 pipeline(s). |
@Yoyozilla Sorry, but what is this restructuring exactly? Is it the table of contents for github.io page? Could you provide a little bit more detail in the pull request please? |
@julenka This is in response to some of the feedback we have gotten. |
/azp run mrtk_docs |
Azure Pipelines successfully started running 1 pipeline(s). |
/azp run mrtk_docs |
Azure Pipelines successfully started running 1 pipeline(s). |
/azp run mrtk_docs |
Azure Pipelines successfully started running 1 pipeline(s). |
Hi yoyo, it looks like the docs build is still failing. The error is: (Documentation/toc.yml#L0) Invalid file link:(~/Documentation/README.md). |
I think also the general feedback was to have in the PR description what is being changed and why. (If you could take your response to Julia's feedback and paste it into the PR description that would be good) |
Per our offline chat, I deleted the stale migration readme, but this causes a merge conflict in yours because I had to update the toc.yml |
/azp run mrtk_docs |
@Yoyozilla ignore if you know / do this already: you can run docfx locally - it just takes a couple of seconds. that way you can easier fix issues / iterate on issues in this PR without having to wait for the CI builder all the time :) |
/azp run mrtk_docs |
Azure Pipelines successfully started running 1 pipeline(s). |
href: TODO.md | ||
- name: Moving your project from HTK to MRTK | ||
href: HTKToMRTKPortingGuide.md | ||
- name: How-to |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unless someone is actually going to do this in the next few days, I recommend not adding new TODOs.
These are very frustrating to read (as a consumer) and are easy to forget about (as a producer)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm going to go ahead and merge this PR as-is to get it in, then add this to my incoming docs PR.
This is in response to some of the feedback we have gotten.
The documents today are more like feature description and overview vs how-to.
How-to should be scenario/task focused to teach people how to complete a tast/scenario.
I am moving the doc ToC reflect more of this.