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

Migrate architecture docs to artifact? #149

Closed
vitiral opened this issue Feb 7, 2019 · 2 comments
Closed

Migrate architecture docs to artifact? #149

vitiral opened this issue Feb 7, 2019 · 2 comments

Comments

@vitiral
Copy link
Contributor

vitiral commented Feb 7, 2019

I'm very interested in this tool and while I was reading it's architecture docs I was wishing there were references to the implementations in code.

I wrote a tool to accomplish exactly this: https://github.com/vitiral/artifact

Would you be interested in me migrating the architecture docs in artifact, then re-exporting them as ARCHITECTURE.md? The advantages would be:

  • auto-links architecture to implementation (view-able on github)
  • source code links to design doc (embedded links in source comments)
  • spc and tst completion tracking
  • lintable, helps make re-architecting easier
@lachlansneff
Copy link
Contributor

Hi, thanks for making an issue!

Your project seems really cool! If you'd like to submit a proof-of-concept as a PR, we'd love to take a look at it.

@syrusakbary
Copy link
Member

Closing this issue for now as it has been inactive for a few months and the PR #154 is also closed.

@vitiral if you would like to continue the work on this please let me know and we can reopen the issue

nlewycky pushed a commit that referenced this issue Aug 13, 2020
fix(api) Use `Self` instead of `Store`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants