Skip to content

Update docs#201

Open
gomoripeti wants to merge 3 commits intoAppliscale:masterfrom
gomoripeti:update_docs
Open

Update docs#201
gomoripeti wants to merge 3 commits intoAppliscale:masterfrom
gomoripeti:update_docs

Conversation

@gomoripeti
Copy link
Contributor

@gomoripeti gomoripeti commented Oct 29, 2021

  • include xprof_core docs (use OTP 24 edoc + latest ExDoc)
  • publish to hexdocs

Note

Modernizes documentation generation and publishing across the project.

  • Replace mix-based ex_doc with rebar3_ex_doc; add gen_ex_doc and publish_docs targets using per-app rebar3 ex_doc
  • New test_docs GitHub Actions job (OTP 26/Elixir 1.15) to validate docs build; remove inline docs build from test matrix
  • Configure docs in rebar.config (project plugin, ex_doc options, docs profile); update hex plugin tag; drop sync from shell apps
  • Add {doc, "doc"} to xprof.app.src and extensive @private/doc comment improvements and minor spec clarifications across xprof_core
  • Fix docs content and examples in doc/src/querysyntax.md

Written by Cursor Bugbot for commit 89aab22. This will update automatically on new commits. Configure here.

@gomoripeti gomoripeti force-pushed the update_docs branch 3 times, most recently from 62dc375 to 7c22d2d Compare October 30, 2021 00:31
- include xprof_core docs (use OTP 24 edoc + latest ExDoc)
- publish to hexdocs
Copy link

@cursor cursor bot left a comment

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Bugbot Autofix is OFF. To automatically fix reported issues with Cloud Agents, enable Autofix in the Cursor dashboard.

This PR is being reviewed by Cursor Bugbot

Details

Your team is on the Bugbot Free tier. On this plan, Bugbot will review limited PRs each billing cycle for each member of your team.

To receive Bugbot reviews on all of your PRs, visit the Cursor dashboard to activate Pro and start your 14-day free trial.


.PHONY: compile dev dev_back_end dev_front_end npm bootstrap_front_end test_front_end build_prod_front_end test doc gen_ex_doc dialyzer publish
publish_docs: gen_ex_doc
./rebar3 as publish hex docs
Copy link

Choose a reason for hiding this comment

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

Hardcoded rebar3 path inconsistent with Makefile pattern

Low Severity

The new publish_docs target uses hardcoded ./rebar3 instead of $(REBAR3). Every other target in the Makefile uses $(REBAR3), which resolves to the system rebar3 or falls back to ./rebar3. This inconsistency means publish_docs will fail for developers who have rebar3 in their PATH but not as a local ./rebar3 file, unlike all other targets including the related publish target which uses $(REBAR3).

Fix in Cursor Fix in Web

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant