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.

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

Improve overall format and style of the mdbook #50

Open
mattaereal opened this issue Aug 24, 2024 · 2 comments
Open

Improve overall format and style of the mdbook #50

mattaereal opened this issue Aug 24, 2024 · 2 comments
Labels
help wanted Extra attention is needed modification Update or content modification request

Comments

@mattaereal
Copy link
Collaborator

What content are you looking to modify or update?

Everything actually. Research on this should be an outcome of this issue.
Maybe we can start by defining a style guide?

Why do you think this update or modification is needed?

Definitively the current formatting and style could use some improvements.

Can you justify your argument and provide additional resources

Also related:

@mattaereal mattaereal added help wanted Extra attention is needed modification Update or content modification request labels Aug 24, 2024
@mattaereal mattaereal added this to the Public visibility for repo milestone Aug 24, 2024
@Robert-MacWha
Copy link
Contributor

Just incorporating a linter might be sufficient. I use prettier, but anything could work.

Something like https://github.com/marketplace/actions/lint-action, running automatically on PR, could help. Standardizes the document & code style by force and still lets people edit it with regular markdown editors. Auto-linting might take it a step too far (would that break anything?), but even just having it enforce similar to the spell check could work.

@mattaereal
Copy link
Collaborator Author

I do also think it could be a great idea!, but it seems that I have failed to bring a more deep subject to the matter, which is something like the diataxis doc framework, to shape the entire frameworks content upon it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed modification Update or content modification request
Projects
None yet
Development

No branches or pull requests

2 participants