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 documentation #17

Open
krzysztofrewak opened this issue Apr 5, 2022 · 1 comment
Open

Add documentation #17

krzysztofrewak opened this issue Apr 5, 2022 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@krzysztofrewak
Copy link
Member

Every public method of every trait in Features namespace should be documented with examples of usage. Right now documentation is a bunch of loose Markdown files, but it would be nice to compile it to something more readable and searchable. GHA and GHP could be used for that.

@krzysztofrewak krzysztofrewak added the documentation Improvements or additions to documentation label Apr 5, 2022
@PiotrFedak PiotrFedak self-assigned this Jun 7, 2024
@krzysztofrewak
Copy link
Member Author

I would like to see something like this:

obraz

krzysztofrewak added a commit that referenced this issue Jun 28, 2024
krzysztofrewak added a commit that referenced this issue Jul 9, 2024
* #17 - documentation draft

* Marking where you are in the documentation, added img, started to create a documentation

* Added toggle between php and Gherkin, also small fixes

Co-Authored-By: Jakub Kermes <[email protected]>

* add documentation for general section

* add documentation Authentication.php

* add rest of the documentation

* listed out included traits

* Added highlighting, fix link error, faq page

* node modules to gitignore

* delete node files that wasn't supposed to be on github

* copy to clipboard and fixes

* Convert to cdn

* add helpers section

* text color change

* Added context classes vs traits

* formatting

* Apply suggestions from code review

Co-authored-by: Ewelina Skrzypacz <[email protected]>

* format list

* FAQ fix

* translation, dispatcher and database fix

* change namespace styling

* toast for clipboard

* Code review changes. Icon for commands, new line and spelling mistake

* Added lines at the end of the file

* custom Higlight

* Fixed gherkin highlight bug

* Fixed copy bug and end line bug

* Tab fixes Translation fix and added more padding

* tabs

---------

Co-authored-by: PiotrFedak <[email protected]>
Co-authored-by: Jakub Kermes <[email protected]>
Co-authored-by: JakubKermes <[email protected]>
Co-authored-by: Piotr Fedak <[email protected]>
Co-authored-by: Ewelina Skrzypacz <[email protected]>
JakubKermes added a commit that referenced this issue Aug 9, 2024
* #17 - documentation draft

* Marking where you are in the documentation, added img, started to create a documentation

* Added toggle between php and Gherkin, also small fixes

Co-Authored-By: Jakub Kermes <[email protected]>

* add documentation for general section

* add documentation Authentication.php

* add rest of the documentation

* listed out included traits

* Added highlighting, fix link error, faq page

* node modules to gitignore

* delete node files that wasn't supposed to be on github

* removed function, can be done using Eloquent.php

* copy to clipboard and fixes

* add missing documentation elements

* add test draft

* fix documentation sidebar

* Convert to cdn

* add helpers section

* text color change

* Added context classes vs traits

* make test prettier

* fix documentation for http

* add missing documentation for view

* formatting

* Apply suggestions from code review

Co-authored-by: Ewelina Skrzypacz <[email protected]>

* format list

* FAQ fix

* translation, dispatcher and database fix

* change namespace styling

* change namespace styling

* toast for clipboard

* Code review changes. Icon for commands, new line and spelling mistake

* Added lines at the end of the file

* custom Higlight

* small fixes

* csf

* suggested changes

* better handling for filenames, add cookies.html

* fix coloring code

* clearer looking DocumentationTest.php

* add hooks to documentation

* suggested changes

* add hooks testing

---------

Co-authored-by: krzysztofrewak <[email protected]>
Co-authored-by: PiotrFedak <[email protected]>
Co-authored-by: Piotr Fedak <[email protected]>
Co-authored-by: Ewelina Skrzypacz <[email protected]>
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
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants