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.

Sign up for GitHub

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

Jump to bottom

refactor: doc improvements (again) #260

Merged
merged 46 commits into from
Dec 26, 2023
Merged

refactor: doc improvements (again) #260

merged 46 commits into from
Dec 26, 2023

Conversation

TorchedSammy
Copy link
Member

@TorchedSammy TorchedSammy commented Aug 26, 2023 •
edited
Loading

HEY

the docs on hilbish are kinda iffy, so here is part 2 of adding more to the documentation (whether web generated or doc command)

and maybe even the emmy lua generated docs
closes #254

doc showcase related:

  • Make functions collapsed?
  • Table of functions (how would this be rendered in doc command?)
    • How to render properly in doc command

the following need to be written for all functions:

  • Parameters
  • Examples

rewrite descriptions on:

  • Modules (Introduction)

    • bait
    • commander
    • fs
    • hilbish

  • Functions

  • Signals

  • Generated docs for lua written modules (nature)

  • Opts

  • I have reviewed CONTRIBUTING.md.
  • My commits and title use the Conventional Commit format.
  • I have documented changes and additions in the CHANGELOG.md.

@TorchedSammy
docs: add detailed parameter listing, change interface to modules
7c19841 
there are a few changes here
- documentation of each parameter separately has been added
to the generated text docs
- interfaces have been renamed to modules. this was honestly a pointless
and confusing distinction (interfaces are tables for modules that are
lua modules). it also makes it so that (formerly) interfaces and
modules line up with each other on the doc list

im not sure what else i did, these are old changes
@TorchedSammy TorchedSammy added the documentation Improvements or additions to documentation label Aug 26, 2023
@TorchedSammy TorchedSammy added this to the v2.2 (Poppy) milestone Aug 26, 2023
@TorchedSammy
docs: add better introduction for bait module
81b7e20 
also highlights codeblocks better
@TorchedSammy
docs: make various style changes
aa7e899 
- add a table that lists module functions
- add highlight when jumping to a function
- separators
@TorchedSammy
docs: change colors for syntax highlight and function jump highlight
22cf0fc
@TorchedSammy
docs(commander): remove note about input sink being unimplemented
eda4fda
@TorchedSammy
docs: turn properties list into a table
0900284 
also fix member functions causing a spam of separators
@TorchedSammy
docs: add separators for types, make object properties into tables
7fd2ed3
@TorchedSammy
docs: fix description of exitCode prop
95ac2e2
@TorchedSammy
docs: fix duplicate functions header
726082b
@TorchedSammy
chore: merge from master
0f923a6
@TorchedSammy
fix: clear before setting statusline
0607a90
@TorchedSammy
refactor: move misc docs for use in hilbish and website
5be4705
@TorchedSammy TorchedSammy mentioned this pull request Nov 14, 2023
Closed
@TorchedSammy
chore: update branch
3065cdd
@TorchedSammy
docs: fix extra backtick in codeblock
7f6c459
@TorchedSammy
fix(nature/greenhouse): fix style override on bottom titles
f3eac9f
@TorchedSammy
fix(commands/doc): fix title rendering, highlight codeblocks
42d86f2
@TorchedSammy
feat(commands/doc): display separator, add space in code block
2cac53d
@TorchedSammy
feat(commands/doc): strip html elements, style markdown properly
5fb8c88
@TorchedSammy
feat(greenhouse): add implementation for horizontal scroll (leave unu…
ec49620 
…sed)
@TorchedSammy
fix(greenhouse): text cutoff in certain cases
a59a029
@TorchedSammy
fix(commands/doc): fix text cutoff, render warning shortcode
fb3915e
@TorchedSammy
docs: move Hooks to Signals
433ffa5
@TorchedSammy
feat: work on nature doc gen
316a818
@TorchedSammy
docs: improve docs for signals
f312cc2
@TorchedSammy
feat: add nature module docs
b0e05d4
@TorchedSammy
docs: add opts
884bc1f
@TorchedSammy
chore: update changelog
d3a9585
@TorchedSammy
docs: fix extra whitespace
0de305a
@TorchedSammy
docs: reorganize text and add more info
3219c47
@TorchedSammy
docs: fix fs.mkdir example
85e1307
@TorchedSammy
docs: minor changes and fixes
48ef443
@TorchedSammy TorchedSammy marked this pull request as ready for review December 26, 2023 03:02
@TorchedSammy TorchedSammy merged commit 8fdae6c into master Dec 26, 2023
19 checks passed
@TorchedSammy TorchedSammy deleted the doc-improvements branch December 26, 2023 03:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
v2.2 (Poppy)
Development

Successfully merging this pull request may close these issues.

docs: unify website and local docs
1 participant
@TorchedSammy