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

Readme link broken #81

Open
tolikzinovyev opened this issue Dec 3, 2024 · 2 comments
Open

Readme link broken #81

tolikzinovyev opened this issue Dec 3, 2024 · 2 comments
Assignees

Comments

@tolikzinovyev
Copy link
Member

Context & versions

A link in readme seems broken. Is this intended?

Screenshot 2024-12-03 at 11-15-44 cardano-scaling_alba Prototype implementation of Approximate Lower Bound Arguments

@curiecrypt
Copy link
Collaborator

@tolikzinovyev it is intentional!
Since we did not publish the crate yet, we don't have a web page hosting our documentation.
So, until we publish it, I decided to put links as it should be. But, of course, it does not look good on the readme page.
If you compile the cargo doc locally, you can see the link works there.

A possible work around could be the following:
I can put the GitHub link for only the doc link appearing on the main README as follows:

## Documentation
📖 We deliver comprehensive [documentation](https://github.com/cardano-scaling/alba/blob/main/docs/intro.md) aimed at connecting theory with practical implementation.

Then, we can replace it with the correct link after publishing.

WDYT?
Also, @djetchev , @rrtoledo

@tolikzinovyev
Copy link
Member Author

Thanks. I'm ok if it stays like this for now. Let's just keep this issue open so we don't forget.

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

No branches or pull requests

2 participants