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

updatge readme and docs #1263

Merged
merged 1 commit into from
Jan 21, 2025
Merged

updatge readme and docs #1263

merged 1 commit into from
Jan 21, 2025

Conversation

franziskuskiefer
Copy link
Member

@franziskuskiefer franziskuskiefer commented Jan 21, 2025

@W95Psp there's more for developer documentation in the readme that's not on the docs yet. How about moving all of that to the dev docs?

There's a little duplication now in the readme and the website. We could solve that by reducing the amount of information in the readme (it's a bit much) and move some of it purely to the website.

@karthikbhargavan when the vstte paper is up, this should be added to the list of publications too.

Copy link
Collaborator

@W95Psp W95Psp left a comment

Choose a reason for hiding this comment

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

Looks good.

About moving dev infos, yes, that makes sense, and we can move the contents but leave a link to the website, wdyt?
Shall we file an followup issue for that?

@franziskuskiefer
Copy link
Member Author

we can move the contents but leave a link to the website, wdyt?
Shall we file an followup issue for that?

Yes, I think moving and linking is the right thing to do. To have only the most interesting things in the readme. Let's file follow ups.

@franziskuskiefer franziskuskiefer added this pull request to the merge queue Jan 21, 2025
Merged via the queue into main with commit 2d56f68 Jan 21, 2025
15 checks passed
@franziskuskiefer franziskuskiefer deleted the franziskus/website-update2 branch January 21, 2025 12:37
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