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

Move HACKING.rst to readthedocs #229

Open
mr-cal opened this issue Jul 31, 2024 · 2 comments
Open

Move HACKING.rst to readthedocs #229

mr-cal opened this issue Jul 31, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation Enhancement New feature or request Triaged

Comments

@mr-cal
Copy link
Contributor

mr-cal commented Jul 31, 2024

  1. Migrate HACKING.rst to starbase documentation such that applications can re-use it in their documentation
  2. Softlink or add a note in HACKING.rst pointing to the documentation
    • This is because developers except to see a hacking guide in the root of a repo
@mr-cal mr-cal added the Triaged label Jul 31, 2024
Copy link

Thank you for reporting us your feedback!

The internal ticket has been created: https://warthogs.atlassian.net/browse/CRAFT-3173.

This message was autogenerated

@medubelko
Copy link
Contributor

medubelko commented Aug 9, 2024

Softlink or add a note in HACKING.rst pointing to the documentation

For metadocs about the codebase, I'd rather we keep files in a format where they're mostly readable without rendering/building or a web browser.

On that note, I'd like to also move away from HACKING as a prevailing file, as the title has negative connotations and the file isn't much of a common practice. Many projects one runs across on GH carry get-up-and-go build instructions early in the README, or sometimes none at all if it's as simple as make install. This means that there will be less DRY between repos, yes, but there's a limit to how much we can modularise historically non-Sphinx documents meant to be read in source. Besides, if we tidy up and consolidate the build, it should be a relatively short section (I hope). If it's on the long side due to testing or whatnot, we can explore other solutions.

@lengau lengau added documentation Improvements or additions to documentation Enhancement New feature or request labels Sep 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation Enhancement New feature or request Triaged
Projects
None yet
Development

No branches or pull requests

3 participants