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

Make forge doc generate documentation for Markdown files other than README.md as well #7924

Open
guidanoli opened this issue May 14, 2024 · 0 comments
Labels
T-feature Type: feature

Comments

@guidanoli
Copy link

Component

Forge

Describe the feature you would like

Currently, forge doc only generates documentation for the contracts and a README.md file.
In some cases, however, there are other Markdown files that could be part of the mdbook.
For example, if the README.md links to other Markdown files, forge doc could generate documentation for those as well, and link accordingly. Example:

# README.md

This project is about ...

[See how to contribute to the project](CONTRIBUTING.md)
# CONTRIBUTING.md

You can contribute in such way ...

Alternatively, a list of Markdown files to generate documentation for could be listed in foundry.toml.

Additional context

No response

@guidanoli guidanoli added the T-feature Type: feature label May 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T-feature Type: feature
Projects
None yet
Development

No branches or pull requests

1 participant