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 documents to artifact #154

Closed
wants to merge 4 commits into from

Conversation

vitiral
Copy link
Contributor

@vitiral vitiral commented Feb 7, 2019

Fixes #149

This is currently a POC (and thus only ports Phase1)

@vitiral
Copy link
Contributor Author

vitiral commented Feb 7, 2019

Here is what the design docs would look like: ARCHITECTURE-NEW.md.

@vitiral
Copy link
Contributor Author

vitiral commented Feb 7, 2019

Notice the .compile, etc links -- they go directly to source code, both tracking the "progress" of architecture completion as well as helping folks find the links when viewing the architecture docs.

Example

The main entry point is .compile, but the machinery is really in the default compiler,
the .clif_compiler.

@xmclark
Copy link
Contributor

xmclark commented Feb 7, 2019

@vitiral thanks for submitting this. The team will be reviewing/evaluating artifact tool sometime this week.

@vitiral
Copy link
Contributor Author

vitiral commented Feb 12, 2019

@xmclark ping

@xmclark
Copy link
Contributor

xmclark commented Feb 12, 2019

Hi @vitiral. We've been pretty busy, so the evaluation has been delayed a bit. I installed the art tool on windows, and am trying to run basic commands. I'm on windows 10, and I installed art with scoop. I can't get many of them to execute correctly.

C:\Users\macke\dev\wasmer>art ls
Encountered Error:

unknown field `code_url`, expected one of `artifact_paths`, `exclude_artifact_paths`, `code_paths`, `exclude_code_paths`
C:\Users\macke\dev\wasmer>art serve
Encountered Error:

unknown field `code_url`, expected one of `artifact_paths`, `exclude_artifact_paths`, `code_paths`, `exclude_code_paths`

@vitiral
Copy link
Contributor Author

vitiral commented Feb 12, 2019

Hey xmclark, windows support has some known bugs. Let me fix them and get back to you.

@syrusakbary
Copy link
Member

Closing the PR as it has become stale.

I will be happy to research more on how we can use artifact for our docs @vitiral. Send me an email to syrus@wasmer.io and we can follow the conversation there :)

nlewycky added a commit that referenced this pull request Aug 13, 2020
Remove references to non-existant clippy.toml.
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 this pull request may close these issues.

Migrate architecture docs to artifact?
3 participants