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

Move the Wiki from HerbSearch to the documentation #122

Open
1 task
IssaHanou opened this issue Jan 30, 2025 · 3 comments
Open
1 task

Move the Wiki from HerbSearch to the documentation #122

IssaHanou opened this issue Jan 30, 2025 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@IssaHanou
Copy link
Member

IssaHanou commented Jan 30, 2025

Removed the pages from the Wiki and added them to the documentation:

  • First start of the Architecture
  • Additional info in the Installation
  • Moved the other files to docs/src/other which are not hosted in the documentation
  • Cross referencing in the documentation is not fully correct

To review please check the online docs

@IssaHanou IssaHanou self-assigned this Jan 30, 2025
@ReubenJ ReubenJ added the documentation Improvements or additions to documentation label Feb 3, 2025
@ReubenJ
Copy link
Member

ReubenJ commented Feb 3, 2025

Nice! Can you open a PR from the documentation branch to master so that someone can review?

@ReubenJ
Copy link
Member

ReubenJ commented Feb 6, 2025

Note: the code used in the guide is outdated (https://herb-ai.github.io/Herb.jl/dev/install/#3.-Run-some-example-code). SymbolTable should be grammar2symboltable.

@pwochner
Copy link
Contributor

I made a new branch documentation-core-concepts and started:

  • Moving the Herb Architecture and Core Concepts to a Pluto notebook. This way, we can execute the code examples and the CI picks up outdated code.
  • Making the tutorial more concise (it is currently quite verbose).

I'll open a PR once it's ready for review.

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

No branches or pull requests

3 participants