[Preview] RDA-generated english/net (not for merge) - #219
Draft
adil-aspose wants to merge 4 commits into
Draft
adil-aspose wants to merge 4 commits into
adil-aspose wants to merge 4 commits into
Conversation
Draft preview of RDA's dotnet-package provider output for review only -- not intended to be merged as-is. Generated directly from the real Aspose.PDF 26.9.0 NuGet package (netstandard2.0), reading the compiled assembly's metadata natively rather than via reflection, with the same exclusion list already agreed for this pilot (Aspose.Foundation, Aspose.Pdf.GroupProcessor). Verified against a fresh run of the actual production xmldocmd tool against the identical assembly/exclusions: namespace-level parity is exact (27/27), and the page-level diff is 0 missing pages either direction once member_pages is enabled to match xmldocmd's own default page depth (constructor/method/property/field/event detail sub-pages). AI description enrichment left off for this run, matching the parity methodology used throughout testing.
description now uses the real site's own "{DeclaringType} {kind}. "
prefix (e.g. "AIClientBase property. Gets or sets the backoff delay in
seconds"), and second_title now includes the " API Reference" suffix
every real Aspose reference page has.
- Generic types (DataResponse<T>, IChatCopilotOptions<T>, etc.) and their members now have real descriptions instead of blank ones -- their XML doc IDs needed an arity marker RDA never added. - Property Value section now shows the real <value> tag text (or is omitted) instead of always showing the bare type name. - Enum Values section now uses the real H3 heading and plain table separator instead of H2 with a centered column.
- visibility: public, matching what xmldocmd actually documents (drops 169 protected-member pages it never produced). - Descriptions: constructors use their own summary; dropped <see cref> and <paramref> names restored; indexer, generic type and generic method summaries found; delegate pages unprefixed. - Property Value section and enum Values heading match the real pages.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This is a preview, not intended to be merged as-is -- it's here so we can review what the Reference Documentation Agent (RDA) actually produces before deciding on next steps.
RDA's new
dotnet-packageprovider reads the compiledAspose.PDF26.9.0 NuGet package (netstandard2.0) directly, via its ECMA-335 metadata, rather than via .NET reflection -- no .NET runtime involved. This replaces the entireenglish/net/tree with RDA's freshly generated output.Verification so far
Before opening this, RDA's output was directly compared against a fresh run of the actual production
xmldocmdtool (not just this repo's current published content, which can lag the real SDK) -- same real compiled assembly, same exclusion list already agreed for this pilot (Aspose.Foundation,Aspose.Pdf.GroupProcessor):member_pagesis enabled to matchxmldocmd's own default page depth (constructor/method/property/field/event detail sub-pages).AI description enrichment was left off for this run to keep the comparison to structure and real doc-comment content only.
What to look for
.rda_url_manifest.json(new, tracks page URLs across runs for future rename/redirect detection) belongs in this repo.Not requesting a merge -- happy to iterate based on feedback here.