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

feat: DocFX baseline (experiment) #1251

Draft
wants to merge 7 commits into
base: v3
Choose a base branch
from
Draft

feat: DocFX baseline (experiment) #1251

wants to merge 7 commits into from

Conversation

DaveSkender
Copy link
Owner

@DaveSkender DaveSkender commented Sep 30, 2024

Caution

Experiment only (do not merge)

done when

  • Add base, remove Jekyll site (experimental, broken)
  • Implement DocFX to auto-generate API
  • add custom filter
  • Fix many, many basic things
  • YAML for redirects, renames from old site (see github.io repo example)
  • Add back metas, SEO, and web vitals configs
  • Handle production vs preview site (e.g. exclude indexing, though may be already in CF headers)
  • Update build/deploy for doc site

image

@DaveSkender DaveSkender added this to the v3 milestone Sep 30, 2024
@DaveSkender DaveSkender self-assigned this Sep 30, 2024
@DaveSkender DaveSkender changed the title feat: DocFX baseline feat: DocFX baseline (experiment) Sep 30, 2024
@DaveSkender

This comment was marked as resolved.

@DaveSkender DaveSkender added the on hold On hold / waiting label Sep 30, 2024
@DaveSkender DaveSkender added the experiment Pseudo-fork for experimental (do not merge) label Oct 27, 2024
@DaveSkender DaveSkender requested a review from Copilot November 15, 2024 23:50

Choose a reason for hiding this comment

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

Copilot reviewed 106 out of 121 changed files in this pull request and generated no suggestions.

Files not reviewed (15)
  • docs/.gitignore: Language not supported
  • docs/404.html: Language not supported
  • docs/GemFile: Language not supported
  • docs/_includes/cyclotron.html: Language not supported
  • docs/_includes/footer.html: Language not supported
  • docs/_includes/head.html: Language not supported
  • docs/_includes/header.html: Language not supported
  • docs/_includes/candle-result.md: Evaluated as low risk
  • README.md: Evaluated as low risk
  • docs/README.md: Evaluated as low risk
  • docs/_indicators/AtrStop.md: Evaluated as low risk
  • docs/_indicators/Alligator.md: Evaluated as low risk
  • docs/_indicators/Beta.md: Evaluated as low risk
  • docs/_indicators/Alma.md: Evaluated as low risk
  • docs/_indicators/Adx.md: Evaluated as low risk
@DaveSkender
Copy link
Owner Author

DaveSkender commented Dec 25, 2024

Some perspective views. Seems a bit clunky with the auto-generated API reference, over-exposing inheritance; and get's a bit hung up from our recursive chaining methods. With that said, it'll do markdown page generation just fine. We'll explore some others.

image

image

image

@DaveSkender DaveSkender added the documentation Improvements or additions to documentation label Dec 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation experiment Pseudo-fork for experimental (do not merge) on hold On hold / waiting
Projects
Development

Successfully merging this pull request may close these issues.

1 participant