[Docs] General updates #1629
[Docs] General updates #1629
Conversation
|
|
||
| export const VersionedUrl = () => ( | ||
| <p> | ||
| <code>{`<head><script src='https://cdnjs.cloudflare.com/ajax/libs/stellar-freighter-api/${packageJson.version}/index.min.js' /></head>`}</code> | ||
| <code>{`<head><script src='https://cdnjs.cloudflare.com/ajax/libs/stellar-freighter-api/{version}/index.min.js' /></head>`}</code> |
There was a problem hiding this comment.
What's the difference between these two? I couldn't find much on the global version.
There was a problem hiding this comment.
For context, I added the original logic around grabbing the package json file because cdnjs creates a url based on the latest version. So, for ex, to get v3.0.0 of freighter-api, you would need a url of: https://cdnjs.cloudflare.com/ajax/libs/stellar-freighter-api/3.0.0/index.min.js
How does the version var accomplish that?
There was a problem hiding this comment.
Ah yeah, so there isn't a global version. I changed it to be consistent with the text instructions here which mentions {version} . This is the only place importing this VersionedUrl component.
There was a problem hiding this comment.
Humm maybe we should just put a plain html code like it's being done here instead of importing this VersionedUrl component. Wdyt?
Something like:
<head><script src="https://cdnjs.cloudflare.com/ajax/libs/stellar-freighter-api/{version}/index.min.js"></script></head>There was a problem hiding this comment.
And leave the VersionedUrl component "as is" or delete it if it's not being used
There was a problem hiding this comment.
Oh, just to give further context: I did originally have it as plain html with the {version} var in it as you suggested, but I got complaints from people in the org that the link should be dynamic and include the latest version so users can just copy and paste without having to insert the version number themself
There was a problem hiding this comment.
This is the original ticket that caused me to add this: #829
This PR suggests some doc updates and fixes some typos.
The main updates would be: