Skip to content

Conversation

adamperkowski
Copy link
Collaborator

@adamperkowski adamperkowski commented Oct 8, 2024

Type of Change

  • Documentation update

Description

  • crated xtask (designed to be very flexible) & xtask docgen for auto-generating the user guide
  • docs/contributing.md is auto generated (copied) from .github/CONTRIBUTING.md

Preview of the magic

2024-10-08_20-35-43.mp4

Testing

GitHub Actions
Docs

Checklist

  • My code adheres to the coding and style guidelines of the project.
  • I have performed a self-review of my own code.
  • I have made corresponding changes to the documentation.
  • My changes generate no errors/warnings/merge conflicts.

@adamperkowski adamperkowski force-pushed the docs_updates branch 6 times, most recently from 8688867 to c785017 Compare October 8, 2024 16:15
`docs/contributing.md` is now auto generated
@adamperkowski adamperkowski changed the title 📔 docs: some updates 📔 docs: cargo xtask + some updates Oct 8, 2024
@adamperkowski adamperkowski marked this pull request as ready for review October 8, 2024 17:51
@adamperkowski
Copy link
Collaborator Author

Suggestions welcome

@adamperkowski adamperkowski changed the title 📔 docs: cargo xtask + some updates 📔 docs: auto docs generation Oct 8, 2024
@adamperkowski adamperkowski changed the title 📔 docs: auto docs generation 📔 docs: auto generation Oct 8, 2024
@ChrisTitusTech ChrisTitusTech merged commit 01d571f into ChrisTitusTech:main Oct 8, 2024
3 checks passed
lennartpj pushed a commit to lennartpj/linutil that referenced this pull request Oct 17, 2024
* remove contributing guidelines duplicate

`docs/contributing.md` is now auto generated

* Commit Contributing Guidelines

* core `xtask` functionality

* almost there

* write panic

* almost almost there

* there.

* remove empty descriptions

* better contributing.md comment

* Commit Contributing Guidelines

* remove entries without descriptions

---------

Co-authored-by: adamperkowski <adamperkowski@users.noreply.github.com>
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