foundry-rs / foundry-rs/foundry

feat: make `forge doc` generate documentation for Markdown files other than `README.md` as well

Open
#7,924 0 comments 1 reaction 0 assignees View on GitHub
C-forge Cmd-forge-doc T-feature T-to-discuss
Dominant language
Rust
Stars
10.6k
Forks
2.6k
Avg merge
18h 20m
Merged PRs (30d)
510

Description

### 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:

```markdown
# README.md

This project is about ...

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

```markdown
# 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_

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.