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

Improve docs organization #1

Open
nicolashuber opened this issue Oct 3, 2020 · 0 comments
Open

Improve docs organization #1

nicolashuber opened this issue Oct 3, 2020 · 0 comments
Labels
enhancement New feature or request

Comments

@nicolashuber
Copy link
Contributor

I suggest organizing the documentation in the following topics:

  • Getting started
    • Why Aztlan?: quickly describe the features
    • Installation
    • Directory structure
  • Configuration
    • Environment variables
  • Theme development
    • Templates: describe where to keep the theme templates
    • Frontend: describe assets directory and basic commands
    • Backend: describe how to create classes to manipulate WordPress
  • Commands: list all Azltan commands

The idea is create a more friendly documentation. For new users understand the purpose of each directory. I already created the branch issue_1 with my initial ideia.

@nicolashuber nicolashuber added the enhancement New feature or request label Oct 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant