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.

Sign up for GitHub

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

Jump to bottom

Remove API reference .md files from the source tree #545

Closed
2 tasks done
CodeMonkeyLeet opened this issue Aug 14, 2018 · 1 comment
Closed
2 tasks done

Remove API reference .md files from the source tree #545

CodeMonkeyLeet opened this issue Aug 14, 2018 · 1 comment
Assignees
@radhikaj
Labels
documentation Issue describes the need for updated or additional documentation for the repo or SDK
Projects
Public preview
Milestone
2018.08

Comments

@CodeMonkeyLeet
Copy link
Contributor

CodeMonkeyLeet commented Aug 14, 2018 •
edited

The current API referenced published in the source tree under doc/md are currently confusing because they are not a complete translation of the doxygen output; the publishing of the .md files into the source tree rely on a custom dox2md tool which currently only publishes functions and not enums, structs, or other meaningful API definitions.

The feedback has been that this has been more confusing than helpful, and we should remove it for public preview as a first step, pending either improvements to the dox2md tool, or perhaps just publishing the doxygen html output directly into GitHub wiki etc.

  • Remove the doc/refman/md folder and its contents
  • Remove references to these files from README.md and doc/README.md
@CodeMonkeyLeet CodeMonkeyLeet added the documentation Issue describes the need for updated or additional documentation for the repo or SDK label Aug 14, 2018
@CodeMonkeyLeet CodeMonkeyLeet added this to the 2018.08 milestone Aug 14, 2018
@CodeMonkeyLeet CodeMonkeyLeet added this to Backlog in Public preview via automation Aug 14, 2018
@CodeMonkeyLeet CodeMonkeyLeet mentioned this issue Aug 15, 2018
Merged
@radhikaj radhikaj assigned radhikaj and unassigned vishnumohan1991 Aug 20, 2018
@radhikaj radhikaj mentioned this issue Aug 20, 2018
Merged
@CodeMonkeyLeet CodeMonkeyLeet mentioned this issue Aug 21, 2018
Closed
3 tasks
radhikaj added a commit that referenced this issue Aug 21, 2018
@radhikaj
Merge pull request #562 from Microsoft/radhikajdocs
38bfc2c 
Move from md to html for API docs to be  hosted on github pages.  #545
@radhikaj radhikaj moved this from Backlog to Done in Public preview Aug 21, 2018
@CodeMonkeyLeet
Copy link
Contributor Author

Resolved by #562

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@radhikaj radhikaj

Labels
documentation Issue describes the need for updated or additional documentation for the repo or SDK
Projects
No open projects
Public preview
  
Done
Milestone
2018.08
Development

No branches or pull requests
3 participants
@radhikaj @CodeMonkeyLeet @vishnumohan1991