fix: resolve type map URL collisions#45
Conversation
1de31e5 to
034eeec
Compare
avivkeller
left a comment
There was a problem hiding this comment.
I don't think these are valid anchors, tbh any PRs changing the type map are kind of irrelevant since we have to overhaul it to be valid anyway.
|
got it, should i work on the overhaul in this PR ? |
034eeec to
73facfb
Compare
73facfb to
d7fa8f7
Compare
|
Following @avivkeller's suggestion to overhaul the type-map instead of patching it, I reworked the generation approach to address URL collisions at the root. The previous implementation relied on getAnchoredURL(), which generates anchors from member names only (e.g., #constructor, #apply), leading to large-scale collisions across classes. I replaced this with a Markdown-driven approach:
Examples: Cache.get → globals.md#class-cache-get This eliminates collisions entirely:
Happy to open a PR with this approach if this direction makes sense. |
|
Hi @TusharThakur04 and @SankalpArya-255! The type map is something that needs a lot of improvements. Merely resolving collisions isn't enough to make sure all the anchors work, and everything that needs to be anchors is properly done so. Because of the complex work that must be taken into account for this change, I feel that it is best this issue be saved until GSoC, where the mentors can more expertly advise on the best course of action. I know I originally labeled the issue that this resolves as one for a good contribution, but after attempting to resolve the issue on my own for a short period of time, I now feel that it is something that the approach must be carefully thought out. For this reason, I am closing this PR. I greatly appreciate the effort put in here, but there's simply more work that needs to be thought out before this can come together (for instance, do we map every type? Do we set up our docs in a way where no map is needed (i.e. by prefixing all types with their file, like I'm curious to see how proposals may tackle the issue of odd types. |

Closes: #3
Summary
This PR :
getFullUrl()What kind of change does this PR introduce?
fix
Did you add tests for your changes?
no
Does this PR introduce a breaking change?
no
If relevant, what needs to be documented once your changes are merged or what have you already documented?
n/a
Use of AI
used ai to skim through the codebase.