Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update low/high level api docs #2031

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

Update low/high level api docs #2031

wants to merge 2 commits into from

Conversation

davidyuk
Copy link
Member

This PR is supported by the Æternity Foundation

@davidyuk davidyuk force-pushed the fix-api-docs branch 3 times, most recently from 89db186 to 7de17db Compare November 18, 2024 13:42
@davidyuk davidyuk requested a review from dincho November 18, 2024 13:44
@davidyuk davidyuk marked this pull request as ready for review November 18, 2024 13:44
@davidyuk davidyuk changed the title Update low/high level api examples Update low/high level api docs Nov 18, 2024
Copy link
Member

@dincho dincho left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure why you're using absolute links to external services/docs while you can use relative to the repo. You plan to update the docs on each release version?

Also the external files examples doesn't make much sense as it's short and can be inlined for better readability flow, otherwise one have to click around.
The same question/comment applies here for absolute urls.

@davidyuk
Copy link
Member Author

can be inlined for better readability flow

they are actually inlined by GitHub
Screenshot 2024-11-19 at 23 05 54
and I also make it work in MkDocs. The problem is that there are only absolute links supported as I understand.
Screenshot 2024-11-19 at 23 11 28
Also, it requires to specify lines, so I'm referencing the commit because if I add a line, it won't show in the docs.
Keeping example code in separate files also allow testing them, to ensure that they are still functional.

@davidyuk
Copy link
Member Author

davidyuk commented Nov 19, 2024

Not sure why you're using absolute links to external services/docs while you can use relative to the repo.

For links like https://docs.aeternity.com/aepp-sdk-js/v14.0.0/api/functions/buildTx.html. I can't reference them relative to the repo because api docs are generated on the docs build step. Instead of v14.0.0 I can reference to latest, but I think this way I may break v14 docs by dropping buildTx in v15. So, I prefer to update the version in links manually than potentially have broken links.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants