build(docs): update throws and examples sections to new titles

[RishhiB]

Consume the updated api-markdown-documenter package to allow custom titles for the @example and @throws sections.

1. The api-markdown-documenter package has utility functions createExamplesSection and createThrowsSection in Helpers.ts which was updated to include a optional headingTitle param in v0.9.0. These functions generate sections that describe the @example and @throws comments on an API item, respectively.

2. At present, the headings "Examples" and "Throws" are hard-coded for these sections. For FF.com, we aim to use custom titles "Usage" for the @example section and "Error Handling" for the @throws section.

3. Adjustments on FF.com:

   • The default title in the examples section should be changed from "Examples" to "Usage".
   • The default title in the throws section should be changed from "Throws" to "Error Handling".

AB#5581

[scottn12]

Looks good! Left a tiny nit if you want :)

[scottn12]

nit: maybe let's move out the string constants "Usage" and "Error Handling" out into consts at the top of this function so they are easier to find in the future?

[Josmithr]

Looks good! I agree with Scott's comments, but otherwise this looks ready to go!

[github-actions]

🔗 Found some broken links! 💔

Run a link check locally to find them. See
https://github.com/microsoft/FluidFramework/wiki/Checking-for-broken-links-in-the-documentation for more information.

linkcheck output

> fluidframework-docs@0.25.0 ci:linkcheck /home/runner/work/FluidFramework/FluidFramework/docs
> start-server-and-test ci:start http://localhost:1313 linkcheck:full

1: starting server using command "npm run ci:start"
and when url "[ 'http://localhost:1313' ]" is responding with HTTP status code 200
running tests using command "npm run linkcheck:full"


> fluidframework-docs@0.25.0 ci:start
> http-server ./public --port 1313 --silent


> fluidframework-docs@0.25.0 linkcheck:full
> npm run linkcheck:fast -- --external


> fluidframework-docs@0.25.0 linkcheck:fast
> linkcheck http://localhost:1313 --skip-file skipped-urls.txt --external

Crawling...

http://localhost:1313/docs/apis/location-redirection-utils/
- (833:52) => http://localhost:1313/docs/apis/container-loader/-entrypoint (HTTP 404)
- (833:52) => http://localhost:1313/docs/apis/container-loader/-entrypoint (HTTP 404)

http://localhost:1313/docs/apis/runtime-definitions/
- (1703:37) 'https://..' => https://datatracker.ietf.org/doc/html/rfc4122%29 (HTTP 404)
- (1703:37) 'https://..' => https://datatracker.ietf.org/doc/html/rfc4122%29 (HTTP 404)

http://localhost:1313/docs/apis/tree/
- (4170:210) 'https://..' => https://github.com/microsoft/FluidFramework/blob/main/packages/loader/container-utils/src/error.ts (HTTP 404)
- (4170:210) 'https://..' => https://github.com/microsoft/FluidFramework/blob/main/packages/loader/container-utils/src/error.ts (HTTP 404)

http://localhost:1313/docs/build/bundlers/
- (843:233) 'here' => https://github.com/microsoft/FluidFramework/blob/a4c38234a920abe9b54b1c26a14c0a8e430cd3fa/packages/tools/webpack-fluid-loader/webpack.config.js#L37 (HTTP 200 but missing anchor)

http://localhost:1313/docs/deployment/service-options/
- (848:72) 'Routerli..' => https://github.com/microsoft/FluidFramework/tree/main/server#readme (HTTP 200 but missing anchor)
- (850:168) 'Routerli..' => https://github.com/microsoft/FluidFramework/tree/main/server#readme (HTTP 200 but missing anchor)

http://localhost:1313/docs/faq/
- (927:87) 'Routerli..' => https://github.com/microsoft/FluidFramework/tree/main/server#readme (HTTP 200 but missing anchor)

http://localhost:1313/docs/testing/telemetry/
- (848:3) 'ILoaderP..' => https://github.com/microsoft/FluidFramework/blob/main/packages/loader/container-loader/src/loader.ts#L313 (HTTP 200 but missing anchor)


Stats:
  207678 links
    2024 destination URLs
       2 URLs ignored
       5 warnings
       3 errors

 ELIFECYCLE  Command failed with exit code 1.