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

specs: Move specs into docs/specs #618

Open
cason opened this issue Nov 27, 2024 · 2 comments
Open

specs: Move specs into docs/specs #618

cason opened this issue Nov 27, 2024 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation spec Related to specifications tech-debt Not high priority, to eventually be addressed.

Comments

@cason
Copy link
Contributor

cason commented Nov 27, 2024

As part of the repository documentation and specs re-organization.

It would not be bad to keep a symlink specs -> docs/specs though.

@cason cason changed the title Move specs into docs/specs specs: move specs into docs/specs Nov 27, 2024
@cason cason added documentation Improvements or additions to documentation spec Related to specifications open-source Tasks required for open-sourcing the repository labels Nov 27, 2024
@cason cason self-assigned this Dec 18, 2024
@romac romac changed the title specs: move specs into docs/specs specs: Move specs into docs/specs Dec 19, 2024
@cason
Copy link
Contributor Author

cason commented Jan 6, 2025

Are we still doing that? I don't find it really necessary.

One reason for considering this change is to render the full docs/ directory as the source for a potentially documentation website, as we have for CometBFT. In the Comet's documentation, we have not really nice workarounds to add the spec/ directory inside the documentation, which is derived from the docs/ directory. See cometbft/cometbft-docs#79 for more context.

@cason
Copy link
Contributor Author

cason commented Jan 6, 2025

It would not be bad to keep a symlink specs -> docs/specs though.

While this is helpful for the transition period (namely, existing links don't break), this become a problem when the Markdown files use relative links (which is the ideal behavior).

@cason cason added tech-debt Not high priority, to eventually be addressed. and removed open-source Tasks required for open-sourcing the repository labels Jan 6, 2025
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 spec Related to specifications tech-debt Not high priority, to eventually be addressed.
Projects
None yet
Development

No branches or pull requests

1 participant