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

Revamp documentation #752

Merged
merged 8 commits into from
Sep 16, 2024
Merged

Conversation

saulecabrera
Copy link
Member

@saulecabrera saulecabrera commented Sep 11, 2024

The objective of this commit is to:

  • Bring the documentation up to date, by removing/correcting the stale pieces
  • Introduce a new organzation approach to documentation making it easier to evolve it over time.
  • Reduce the text-density of the README

In general this commit strives to add as little new information as possible and primarily re-organizes the existing documentation. The only extra documentation is the JavaScript API support, which was lacking as correctly noted in #749 (comment)

Checklist

  • I've updated the relevant CHANGELOG files if necessary. Changes to javy-cli and javy-core do not require updating CHANGELOG files.
  • I've updated the relevant crate versions if necessary. Versioning policy for library crates
  • I've updated documentation including crate documentation if necessary.

The objective of this commit is to:

* Bring the documentation up to date, by removing/correcting the stale
  pieces
* Introduce a new organzation approach to documentation making it easier
  to evolve it over time.
* Reduce the text-density of the README

In general this commit stives to add as little new information as
possible and primarily re-organizes the existing documentation.
@saulecabrera saulecabrera marked this pull request as ready for review September 13, 2024 14:40
Copy link
Collaborator

@jeffcharles jeffcharles left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

Any reason for the leading docs- on the filenames in the docs directory?

Only change I'd really like to see made is the one to remove the duplicate cargo +stable install cargo-hack --locked, others are all nits.

docs/docs-contributing-developing.md Outdated Show resolved Hide resolved
docs/docs-contributing-testing-locally.md Outdated Show resolved Hide resolved
docs/docs-using-js-api-support.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@saulecabrera
Copy link
Member Author

saulecabrera commented Sep 16, 2024

Any reason for the leading docs- on the filenames in the docs directory?

No strong reason. I wanted to make sure that we can easily move these files around if need be (independent of the directory) allowing us to fully disambiguate them from other markdown files (in case we introduce new ones).

@saulecabrera saulecabrera enabled auto-merge (squash) September 16, 2024 16:32
@saulecabrera
Copy link
Member Author

I'm not sure why the jobs seem to be stuck. I'll close and re-open.

@saulecabrera saulecabrera reopened this Sep 16, 2024
@saulecabrera saulecabrera merged commit ba77f05 into bytecodealliance:main Sep 16, 2024
7 checks passed
@saulecabrera saulecabrera deleted the revamp-docs branch September 16, 2024 18:28
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.

2 participants