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

Docs Writing Style Guide / Best Practices #1792

Closed
wants to merge 2 commits into from

Conversation

Siegfried-B
Copy link
Contributor

A draft document for a style guide.
Can be used as a starting point.

Siegfried-B and others added 2 commits February 8, 2024 20:22
A draft document for a style guide that can be used as a starting point
@jthiller jthiller changed the title Create styleguide.md Create Docs Writing Style Guide / Best Practices Feb 8, 2024
@jthiller jthiller changed the title Create Docs Writing Style Guide / Best Practices Docs Writing Style Guide / Best Practices Feb 8, 2024
@Siegfried-B
Copy link
Contributor Author

Siegfried-B commented Feb 8, 2024

Anything necessary to be done before, e.g. @waveform06 can approve/merge?

@jthiller
Copy link
Contributor

jthiller commented Feb 8, 2024

The page should be "user-ready" since folks will see it without the context of knowing it's a work in progress. It doesn't need to be content-complete, but it should not have blank sections.

Also, we need to add it to navigation.

@Siegfried-B
Copy link
Contributor Author

Siegfried-B commented Feb 9, 2024

Ah, I thought it would be used "internally" by the contributors to the scribathon, only accessible through the Github repo for the time being. And inserted the templates/placeholders to make it easier for others to contribute and to make it clear that we probably need more categories.

@jthiller
Copy link
Contributor

jthiller commented Feb 9, 2024

love "scribathon" 😄

For the purposes of this event we could just keep it in a PR or Issue. However, I think this has longterm value for docs contributors outside of this event.

@jthiller jthiller added the Solana Scribes 2024 Issues and PRs related to the Hackathon - solanascribes.com label Feb 9, 2024
@jthiller jthiller closed this Jan 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Solana Scribes 2024 Issues and PRs related to the Hackathon - solanascribes.com
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants