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

Add bare reference to docs #88

Merged
merged 10 commits into from
Mar 13, 2024
Merged

Add bare reference to docs #88

merged 10 commits into from
Mar 13, 2024

Conversation

heyitsvi
Copy link
Contributor

@heyitsvi heyitsvi commented Mar 8, 2024

Bare Reference section includes :

  • Overview
  • API
  • Node.js Compat
  • Bare Module

Updated SUMMARY and README for the same.

@heyitsvi heyitsvi requested a review from subashsn March 8, 2024 15:49
@@ -0,0 +1,173 @@
# API

Copy link
Contributor

Choose a reason for hiding this comment

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

Add an intro like in Pear API
https://docs.pears.com/pear-runtime/api

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

Everything else if left to userland modules to be implemented using these primitives, keeping the runtime itself succinct and _bare_.

## API
Find the Bare API specs [here](./api.md).
Copy link
Contributor

Choose a reason for hiding this comment

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

New line. + Expand a little hire, just a line. on what it allows it you to do

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

@subashsn subashsn marked this pull request as ready for review March 12, 2024 12:19
@rafapaezbas rafapaezbas merged commit 54ce869 into main Mar 13, 2024
5 checks passed
@rafapaezbas rafapaezbas deleted the add-bare-ref branch March 13, 2024 08:20
subashsn pushed a commit that referenced this pull request Mar 13, 2024
* add files in bare ref

* update SUMMARY to contain bare ref

* update README to point to bare ref

* typo fix

* move modules section

* add intro to API

* tiny fix

* add intro to bare modules

* add description to cond exports

* remove api section from bare modules

---------

Co-authored-by: Vivek Singh <[email protected]>
Co-authored-by: Vivek Singh <[email protected]>
Co-authored-by: Vivek Singh <[email protected]>
rafapaezbas added a commit that referenced this pull request Mar 21, 2024
* Add bare reference to docs (#88) (#91)

* add files in bare ref

* update SUMMARY to contain bare ref

* update README to point to bare ref

* typo fix

* move modules section

* add intro to API

* tiny fix

* add intro to bare modules

* add description to cond exports

* remove api section from bare modules

---------

Co-authored-by: Vivek Singh <[email protected]>
Co-authored-by: Vivek Singh <[email protected]>
Co-authored-by: Vivek Singh <[email protected]>

* removed app logic and assets (#90)

Co-authored-by: rafapaezbas <[email protected]>

* move bare ref and update links (#93)

* move bare ref and update links

* move pear ref into subfolder

* update README

* tiny fix

---------

Co-authored-by: Vivek Singh <[email protected]>

---------

Co-authored-by: Vivek Singh <[email protected]>
Co-authored-by: Vivek Singh <[email protected]>
Co-authored-by: Vivek Singh <[email protected]>
Co-authored-by: rafapaezbas <[email protected]>
rafapaezbas added a commit that referenced this pull request Mar 21, 2024
* Add bare reference to docs (#88) (#91)

* add files in bare ref

* update SUMMARY to contain bare ref

* update README to point to bare ref

* typo fix

* move modules section

* add intro to API

* tiny fix

* add intro to bare modules

* add description to cond exports

* remove api section from bare modules

---------

Co-authored-by: Vivek Singh <[email protected]>
Co-authored-by: Vivek Singh <[email protected]>
Co-authored-by: Vivek Singh <[email protected]>

* removed app logic and assets (#90)

Co-authored-by: rafapaezbas <[email protected]>

* move bare ref and update links (#93)

* move bare ref and update links

* move pear ref into subfolder

* update README

* tiny fix

---------

Co-authored-by: Vivek Singh <[email protected]>

---------

Co-authored-by: Vivek Singh <[email protected]>
Co-authored-by: Vivek Singh <[email protected]>
Co-authored-by: Vivek Singh <[email protected]>
Co-authored-by: rafapaezbas <[email protected]>
rafapaezbas added a commit that referenced this pull request Mar 21, 2024
* Add bare reference to docs (#88) (#91)

* add files in bare ref

* update SUMMARY to contain bare ref

* update README to point to bare ref

* typo fix

* move modules section

* add intro to API

* tiny fix

* add intro to bare modules

* add description to cond exports

* remove api section from bare modules

---------

Co-authored-by: Vivek Singh <[email protected]>
Co-authored-by: Vivek Singh <[email protected]>
Co-authored-by: Vivek Singh <[email protected]>

* removed app logic and assets (#90)

Co-authored-by: rafapaezbas <[email protected]>

* move bare ref and update links (#93)

* move bare ref and update links

* move pear ref into subfolder

* update README

* tiny fix

---------

Co-authored-by: Vivek Singh <[email protected]>

---------

Co-authored-by: Vivek Singh <[email protected]>
Co-authored-by: Vivek Singh <[email protected]>
Co-authored-by: Vivek Singh <[email protected]>
Co-authored-by: rafapaezbas <[email protected]>
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.

3 participants