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

Split top-level specification files subsections into multiple files #92

Open
kMutagene opened this issue Jan 23, 2024 · 0 comments
Open

Comments

@kMutagene
Copy link
Member

I suggest we split the current top-level .md files into files in a subfolder according to section headers.

Example: ARC specification.md should turn into a folder that contains each section as a page. The advantage of this is we can stop working on a single file and improve tracking of what PRs actually change, because they will then target a file in the folder structure instead of a monolithic markdown file.

Additionally, a folder structure like that nicely translates into a web version of the specs that does not overload a single page with hard to skim-through content.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

No branches or pull requests

1 participant