search

AmbientRun / Ambient

The multiplayer game engine
https://ambient.run
Apache License 2.0
3.8k stars 124 forks source link

Added URL to component and field type mismatch error messages #1184

Open droqen opened 12 months ago

droqen commented 12 months ago

My attempt to resolve #1183 I haven't successfully built Ambient from this, I tried and it took a super long time... but I do expect it to work. The change is very small.

droqen commented 12 months ago

Rather than give a list of all types (very long, dynamic), I put a link in the error message to the relevant section in the book (shorter, static, but might change). Is that something we're avoiding doing for some reason?

The intended (untested) error message would look like this:

Error: Failed to resolve dependencies for pre-build

Caused by:
    Failed to resolve type `Usize` for component `boid_neighbour_count`
    See https://ambientrun.github.io/Ambient/reference/package.html#valuetype for valid types
philpax commented 12 months ago

Looks good to me, but we might want to use https://ambient.run/docs/reference/package instead. However... that might be out of date (it's not updated automatically with the repo - but we probably want versioning instead), and more annoyingly, it doesn't have anchors (https://github.com/AmbientRun/Web/issues/47).

@FredrikNoren Have we decided where the docs should live? If it's ambient.run then I'll see if I can fix up the anchors issue and we'll deal with versioning later I suppose

philpax commented 12 months ago

Ok, thought about it some more, we should use ambient.run. I've fixed #47, so you should be able to replace the URL with https://ambient.run/docs/reference/package#valuetype - once you've done that, feel free to merge it!

EDIT: Okay I just actually tested that link and the anchor routing is broken 🤦 Let me see...

EDIT2: Yeah no idea, I think the anchor's being stripped off by the routing or something

droqen commented 12 months ago

Oops, I missed your edit. I made an issue for it, haha. #1191