esi / esi-docs

The official repository for ESI documentation
MIT License
145 stars 60 forks source link

eve-glue and esi.evetech.net #26

Open GoldenGnu opened 5 years ago

GoldenGnu commented 5 years ago

I would do it myself, but, it end up being CarbonAlabel who did all the work the last time...

CarbonAlabel commented 5 years ago

Some thoughts on this:

As mentioned in https://github.com/esi/eve-glue#readme, it would be best if apps used the string values returned by ESI enums, and not the IDs and bitmasks that are used to represent them in the monolith, so if anything, I'd link to it from the "Transitioning from XML/CREST" docs.

The front page of the docs could indeed use a nice, big link to https://esi.evetech.net/. As for https://docs.esi.evetech.net/docs/esi_introduction.html, it could use an overhaul to make it read less like marketing talk (which, being a copy-paste of https://developers.eveonline.com/blog/article/introducing-the-esi-api, it actually is), and more like a guide on taking your first steps with ESI.

GoldenGnu commented 5 years ago

ESI enums is the right way to store those values, but, to get the text used in-game, you still need to do enum -> id -> sde. Therefore, It is my opinion is that glue is still an important part of ESI development and should be part of the documentation (until an alternative to get the in-game text is available). That is just my opinion, though, and I may be totally wrong...