Pete Gonzalez

Results 687 comments of Pete Gonzalez
trafficstars

> As an example, for DocFX, the import/include syntax is defined here: [File Inclusion](https://dotnet.github.io/docfx/spec/docfx_flavored_markdown.html?tabs=tabid-1%2Ctabid-a#file-inclusion). I don't see the value in constraining this to a specific syntax given that it can...

If `` and `` are generally the only important parameters, the *generic* solution would be pretty straightforward. It can just follow `{@link}` syntax: ``` /** * Some external content gets...

> Should this be usable for non-markdown includes, such as code snippets? I'm thinking this might be up to the discretion of the particular documentation tool. At least, the original...

> This is where I think we just need to ensure that TSDoc has flexibility in the Markdown markup. We are working on adding Markdown extensions to docs.microsoft.com and therefore...

The filename was always intended to be something like `my-package.api.md`, not `API.md`. Although it wasn't strictly enforced, [the docs](https://api-extractor.com/pages/configs/api-extractor_json/#apireportreportfilename) are pretty clear about that convention: ![image](https://github.com/user-attachments/assets/745f41dd-a789-45e8-926e-c6b6c1d95e90) The change in behavior...

This PR clarifies the documentation: https://github.com/microsoft/rushstack/pull/4846

> We've built plenty of automation around assumption that we can have `/packages//API.md` files present. If we allow `API.md` and then you enable the `reportVariants` feature, how would the variants...

These promises should be postponed until after the first user interaction with the search box: https://github.com/praveenn77/docusaurus-lunr-search/blob/b8a13b68970fcb6fd2adc6f81f7471bf3aedb748/src/theme/SearchBar/index.jsx#L70-L74

@bartvandenende-wm has proposed a simple fix in https://github.com/microsoft/rushstack/pull/4468 However I'd like to consider requiring a logging name for every operation, as illustrated in my alternate PR #4469

Also, in testing this change, I noticed that the reported watcher seems a bit counterintuitive: Using `heft start` in `heft-web-rig-app-tutorial`: - Saving a change to **start.tsx** prints these logs: ```...