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

feat: Add index_documentation #90

Merged
merged 1 commit into from
Jan 12, 2024
Merged

feat: Add index_documentation #90

merged 1 commit into from
Jan 12, 2024

Conversation

liyishuai
Copy link
Member

Motivated by #74 (comment).

index.md currently has no customizable entries. Should we reuse documentation in README or create a new field?

@liyishuai
Copy link
Member Author

Is there a plan to review this PR?
coq-ext-lib has been using an old version of templates for generating its homepage: coq-community/coq-ext-lib@92470dd
Maybe worth unpinning the version before we're too far behind.

@palmskog
Copy link
Member

palmskog commented Jan 10, 2024

I missed this PR before. One issue I have is that some projects might not want documentation to show up in their HTML documentation, since it may contain GitHub-specific Markdown and be very long. @liyishuai Is there a way to make it possible to "opt out" of including documentation in index.md? I don't mind if the default is to include documentation.

@liyishuai liyishuai changed the title Add documentation to index.md feat: Add index_documentation Jan 11, 2024
@liyishuai
Copy link
Member Author

To provide our users full flexibility, I made index_documentation a separate field.

@palmskog
Copy link
Member

Thanks, this is fine by me.

@palmskog palmskog merged commit 078c045 into master Jan 12, 2024
2 checks passed
@palmskog palmskog deleted the index-documentation branch January 12, 2024 18:51
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