dapr / js-sdk

Dapr SDK for Javascript
Apache License 2.0
197 stars 82 forks source link

Add cascading docs metadata #513

Closed AaronCrawfis closed 1 year ago

AaronCrawfis commented 1 year ago

Adds cascading metadata to the docs so edit/view buttons work as expected

Partially addresses https://github.com/dapr/docs/issues/1895

Signed-off-by: Aaron Crawfis Aaron.Crawfis@microsoft.com

codecov[bot] commented 1 year ago

Codecov Report

Merging #513 (985b772) into main (b1a6efb) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #513   +/-   ##
=======================================
  Coverage   35.22%   35.22%           
=======================================
  Files          90       90           
  Lines       10142    10142           
  Branches      415      415           
=======================================
  Hits         3573     3573           
  Misses       6503     6503           
  Partials       66       66           
shubham1172 commented 1 year ago

Without cascading docs:

image

With cascading docs:

image

@AaronCrawfis the JS SDK link seems to be broken.

AaronCrawfis commented 1 year ago

@AaronCrawfis the JS SDK link seems to be broken.

@shubham1172 this PR will need to be merged first: https://github.com/dapr/docs/pull/3612

The path_base_for_github_subdir Docsy parameter wasn't introduced until recently, which the main Dapr docs repo hasn't updated yet. The docs PR brings in the one partial template into the docs repo so the URL will be generated correctly. If you switch your docs branch to aacrawfi/meta-template it should generate as expected.

shubham1172 commented 1 year ago

Thanks, it works now. image