-
Notifications
You must be signed in to change notification settings - Fork 9
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
Less opinionated and simpler minimal config #355
Comments
Cleaning the previews is already an issue, just linked it. The rest of the docs comments seem good. Let's see how they render with the changes. Why the
@CasBex, let me know if you want to work on any of these issues. |
I'm not too familiar with all the CI stuff so I'm not really the right person for this I think. |
No prob, I'll update it. |
Some comments, discussed with @gdalle:
I am releasing 0.9.0 right now with these changes. |
@allcontributors please add @gdalle for ideas |
Some of these were discussed in person at the JuliaCon 2024 Hackathon and some were implemented. I'll close, but feel free to open with comments on what it missing. |
Description
Edit: Moved the list here so it works
docs/make.jl
#357Here are a few changes I'd like to see in the default config before we (re-)generate FixMe.jl:
For docs:
nice_name
is not needed because Documenter.jl will automatically pull the title of the markdown file (and not the file name) if you put file names instead of pairs in thepages
argument tomakedocs
doctest=true
because it is the defaultlinkcheck=false
because Documenter.jl's linkcheck also checks internal referencesrepo=...
because Documenter.jl figures it out itself from a GitHub repoprettyurls=true
because it is the defaultassets=...
to have default stylingpush_preview
, or add a CI workflow to clean up the previews after closingFor the rest:
JuliaFormatter.toml
empty or pick a generic style guide (style="blue"
is a good choice) instead of individual custom options.editorconfig
emptyCODECOV_TOKEN
supposed to be in uppercase?Ping @abelsiqueira and @CasBex
The text was updated successfully, but these errors were encountered: