Skip to content

Add README.md to docs dir.#55

Merged
mattsignorelli merged 1 commit into
mainfrom
docs01
Jun 30, 2025
Merged

Add README.md to docs dir.#55
mattsignorelli merged 1 commit into
mainfrom
docs01

Conversation

@DavidSagan

Copy link
Copy Markdown
Member

No description provided.

@mattsignorelli

Copy link
Copy Markdown
Member

This should probably be in a For Developer's section of the documentation. Do you agree?

For the index.md part of the documentation, we can automatically include the github README by adding this into the make.jl file:

cp(joinpath(@__DIR__, "..", "README.md"), joinpath(@__DIR__, "src", "index.md"); force=true)

@DavidSagan

Copy link
Copy Markdown
Member Author

I was imagining that only developers would look at the docs area so no need of a developers section. But if you want it, it is fine with me. Just tell me what you think.

@DavidSagan

Copy link
Copy Markdown
Member Author

Also at this point in time my inclination is to not automatically copy the github README.md file to the docs since the file has extra stuff to display build status.

@mattsignorelli mattsignorelli merged commit 6947daf into main Jun 30, 2025
4 checks passed
@mattsignorelli mattsignorelli deleted the docs01 branch June 30, 2025 18:33
@DavidSagan

Copy link
Copy Markdown
Member Author

By the way, I tried to put the cp command in make.jl and it caused the server to go in an infinite loop.

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