IDocsContentProvider.cs 760 B

1234567891011121314151617
  1. namespace Shared.Rcl.Docs;
  2. /// <summary>
  3. /// Supplies the raw documentation assets shipped under
  4. /// _content/Shared.Rcl/raw_docs. The Blazor Server host reads them from
  5. /// the static web assets on disk; fetching them over HTTP would require
  6. /// the container to reach its own public URL, which fails behind a
  7. /// reverse proxy (issue #304). The WebAssembly viewer fetches them over
  8. /// HTTP relative to the app base, which is always reachable there.
  9. /// </summary>
  10. public interface IDocsContentProvider {
  11. /// <summary>
  12. /// Returns the content of a file under raw_docs (e.g. "overview.md",
  13. /// "docs-index.json"). Throws if the file does not exist.
  14. /// </summary>
  15. Task<string> GetAsync(string fileName);
  16. }