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

Standardize location of example configs and other docs #5575

Open
wileyj opened this issue Dec 16, 2024 · 1 comment
Open

Standardize location of example configs and other docs #5575

wileyj opened this issue Dec 16, 2024 · 1 comment
Assignees
Labels
documentation Requires new or updates to our documentation good first issue Appropriate for a new open source contribution.

Comments

@wileyj
Copy link
Contributor

wileyj commented Dec 16, 2024

ex: ./testnet/stacks-node/conf

should be moved to a more standardized location like ./docs, ./contrib or a top-leval ./examples folder.

ref #5551

@wileyj wileyj added good first issue Appropriate for a new open source contribution. documentation Requires new or updates to our documentation labels Dec 16, 2024
@github-project-automation github-project-automation bot moved this to Status: 🆕 New in Stacks Core Eng Dec 16, 2024
@wileyj
Copy link
Contributor Author

wileyj commented Dec 18, 2024

This is growing a bit larger than i anticipated - the sample configs are used/referenced in other places that i'll need to dig into like ./docs/profiling.md

the basic idea i'm pursuing here is:
move testnet/stacks-node/conf -> sample/conf
mv sample-contracts -> sample/contracts

update all references in the repo to point to the new location (side note: in develop, testnet/stacks-node/conf is a symlink to ./stackslib/conf, i plan to link that in reverse so that stackslib has the symlink to ./sample/conf).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Requires new or updates to our documentation good first issue Appropriate for a new open source contribution.
Projects
Status: Status: 🆕 New
Development

No branches or pull requests

1 participant