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.

Sign up for GitHub

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

Jump to bottom

[FEAT] Rename all OVERVIEW.md files to README.md #2695

Closed
Tracked by #2682
damienwebdev opened this issue Dec 28, 2023 · 2 comments
Closed
Tracked by #2682

[FEAT] Rename all OVERVIEW.md files to README.md #2695

damienwebdev opened this issue Dec 28, 2023 · 2 comments
Assignees
@xelaint
Labels
docs This issue is related to documentation good first issue This issue is a good place to start for first time contributors p1 critical priority package: daff.io @daffodil/daff.io
Milestone
Daffodil v1.0

Comments

@damienwebdev
Copy link
Member

damienwebdev commented Dec 28, 2023 •
edited by xelaint
Loading

💡 Feature request

Feature Name

Rename all OVERVIEW.md files to README.md

The Desired Behavior

All markdown files that are titled OVERVIEW.md should be renamed to README.md

Your Use Case

As a Daffodil core developer, I would like docs generation to correctly generate the overview docs for each package.

Environment


Daffodil version: 0.66.1
Angular version: 15.2.0

 
For Tooling issues:
- Node version: XX  
- Platform:  

Others:
@damienwebdev damienwebdev mentioned this issue Dec 28, 2023
Open
26 tasks
@damienwebdev damienwebdev changed the title Rename all OVERVIEW.md to README.md. [FEAT] Rename all OVERVIEW.md to README.md. Dec 28, 2023
@damienwebdev damienwebdev added docs This issue is related to documentation package: daff.io @daffodil/daff.io p1 critical priority labels Dec 28, 2023
@damienwebdev damienwebdev added this to the Daffodil v1.0 milestone Dec 28, 2023
@damienwebdev damienwebdev added the good first issue This issue is a good place to start for first time contributors label Dec 28, 2023
@xelaint xelaint changed the title [FEAT] Rename all OVERVIEW.md to README.md. [FEAT] Rename all OVERVIEW.md files to README.md Dec 28, 2023
@xelaint
Copy link
Member

xelaint commented Jan 8, 2024

@damienwebdev There are actually no readme files that are named OVERVIEW.md in Daffodil.

@damienwebdev
Copy link
Member Author

Awesome!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@xelaint xelaint

Labels
docs This issue is related to documentation good first issue This issue is a good place to start for first time contributors p1 critical priority package: daff.io @daffodil/daff.io
Projects
None yet
Milestone
Daffodil v1.0
Development

No branches or pull requests
2 participants
@damienwebdev @xelaint