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

docs: demote some packages from developer API product #2181

Merged
merged 1 commit into from
Mar 29, 2024
Merged

Conversation

dckc
Copy link
Collaborator

@dckc dckc commented Mar 26, 2024

refs: Agoric/documentation#1031

Description / Documentation Considerations

In Agoric/documentation#1031 , we aim to define "the developer API product" and to supply corresponding reference docs.

This is a proposal to exclude whole packages from consideration, leaving them as implementation details or some such.

@sufyaankhan

Security / Scaling / Testing / Upgrade Considerations

n/a

Compatibility Considerations

This could lower some compatibility burdens.

@erights
Copy link
Contributor

erights commented Mar 26, 2024

The windows CI test seems to be flaky, so I restarted your failed one.

@dckc dckc changed the title docs: demote some modules from developer API product docs: demote some packages from developer API product Mar 26, 2024
Copy link
Contributor

@erights erights left a comment

Choose a reason for hiding this comment

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

All the exclusions except env-options and errors LGTM. But these two, especially errors is something that IMO should be exposed and explained to developers. At least errors.

typedoc.json Outdated Show resolved Hide resolved
typedoc.json Outdated Show resolved Hide resolved
typedoc.json Show resolved Hide resolved
@dckc dckc enabled auto-merge (rebase) March 26, 2024 20:05
@dckc dckc merged commit 6cd8e87 into master Mar 29, 2024
18 checks passed
@dckc dckc deleted the dc-api-boundary branch March 29, 2024 17:02
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.

None yet

4 participants