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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add TOC to README #157

Closed
wants to merge 1 commit into from
Closed

Add TOC to README #157

wants to merge 1 commit into from

Conversation

pllim
Copy link
Contributor

@pllim pllim commented Sep 23, 2022

I do not want to click on each and every folder to see what the SPECs are about, so would be nice to have a TOC like https://github.com/astropy/astropy-APEs . 馃槄

I am not sure if these are the columns you want, so I am happy to modify the columns. Would be nice for outsider to see the statuses of the SPECs at a glance too. And once SPEC is accepted, would be nice to have a permanent DOI people can cite.

@jarrodmillman
Copy link
Member

This is auto-generated: https://scientific-python.org/specs/ and has all the information in the README table, but will also automatically include additional information that may be hard to include in the README (for example which projects have endorsed the SPEC and what its status is).

I would rather not have too much additional manual work needed. I also don't like having to manually format tables. Is the website not sufficient? If not, maybe we should consider improving the quickstart.py script to also update the README using tabulate or something.

@pllim
Copy link
Contributor Author

pllim commented Sep 28, 2022

Okay, fair point. I will close this.

@pllim pllim closed this Sep 28, 2022
@pllim pllim deleted the patch-1 branch September 28, 2022 21:16
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.

None yet

2 participants