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

Make "How To" Guide Title Convention Consistent #481

Closed
alexlmiller opened this issue Oct 2, 2023 · 2 comments
Closed

Make "How To" Guide Title Convention Consistent #481

alexlmiller opened this issue Oct 2, 2023 · 2 comments
Assignees
Labels
Cleanup Documentation clean up documentation Improvements or additions to documentation

Comments

@alexlmiller
Copy link
Contributor

Currently some of the page titles for How To Guides are “How to XXXXXXX” while others are just “XXXXXXX” and the ‘how to’ is implied from the section.

We should pick one format for titles & urls there and rationalize them.

@github-project-automation github-project-automation bot moved this to 🆕 New in Hiro Docs Oct 2, 2023
@alexlmiller alexlmiller added Cleanup Documentation clean up docathon labels Oct 2, 2023
@alexlmiller
Copy link
Contributor Author

CC @ryanwaits on this since it should be a consistent decision across everything

@ryanwaits ryanwaits added documentation Improvements or additions to documentation and removed docathon labels Jan 27, 2024
@ryanwaits ryanwaits self-assigned this Jul 1, 2024
@ryanwaits
Copy link
Collaborator

since there is no "how to" section anymore i think we can probably close this for now. we do however still mix up the titles of our guides to sometimes say "how to x", which I think is fine with and doesnt need to be standardized everywhere

for example: https://docs.hiro.so/guides/sync-a-bitcoin-node read "how to sync a bitcoin node"

and: https://docs.hiro.so/stacks/stacks.js/guides/broadcast-transactions is just "broadcast transactions"

lmk if this is good to close @alexlmiller

@ryanwaits ryanwaits added this to Devrel Jul 1, 2024
@github-project-automation github-project-automation bot moved this to 🆕 New in Devrel Jul 1, 2024
@github-project-automation github-project-automation bot moved this from 🆕 New to ✅ Done in Devrel Sep 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Cleanup Documentation clean up documentation Improvements or additions to documentation
Projects
Archived in project
Status: 🆕 New
Development

No branches or pull requests

2 participants